Bitbucket is a code hosting site with unlimited public and private repositories. We're also free for small teams!

Close

sphinxcontrib-recentpages: Sphinx Recent Pages Extension

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

Recent activity

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.