Skip to main content

UNKNOWN

Project description

This sphinx extension provides a new directive which displays recent updated files list.

Introduction

This sphinx extension provides a new directive which displays recent updated files list. If you want to get all page list ordered by mtime, just put recentpages directive as follows:

.. recentpages::

If you want to display recent 3 files only, add num option to the directive:

.. recentpages::
    :num: 3

Install

Use easy_install:

easy_install sphinxcontrib-recentpages

Then add the following line into source/conf.py:

extensions += ['sphinxcontrib.recentpages']

Recentpages on sidebar

Recentpages can be displayed on sidebar.

First, please enable recentpages_sidebar in source/conf.py:

recentpages_sidebar = True

After you enable this, recentpages extension will create a template file ‘recentpages.html’ in your template path ( ‘_templates’ by default ).

Please make sure ‘template_path’ property contains at least 1 writable directory if you customize ‘template_path’.

Then add ‘recentpages.html’ to ‘html_sidebars’ dictionary. For example, add the following line to source/conf.py if you want to add under the default sidebar:

html_sidebars = {'**': ['localtoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html', 'recentpages.html']}

By default, 5 pages are displayed on sidebar. If you want to change the number of pages on the list, please change ‘recentpages_sidbar_pages’ property:

recentpages_sidebar_pages = 10

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxcontrib-recentpages-0.7.1.tar.gz (8.3 kB view hashes)

Uploaded Source

Built Distribution

sphinxcontrib_recentpages-0.7.1-py2.7.egg (19.1 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page