Sphinx supports various notice blocks but the oslosphinx theme
does support only warning and note. openstackdoctheme used by
openstack-manuals project supports 'important', 'tip' and 'caution'
blocks. It would be nice if oslosphinx support these notices.
It reduces confusions on contributors to both types of projects.
When git cmd fails, raw_version_list is set to empty 'str' and then
we are trying to decode it. This patch moves decoding inside try/catch
block, so we are decoding return value of subprocess call, which is bytes
in Python 3.
Adds a new option that allows the "Other Versions" section to be removed
if a project isn't interested in showing links to older versions. The
default value is False which means that it will be hidden.
Even though the setting is not backward compatible there are enough
broken documentation links in the OpenStack projects that this should be
Make the first one link to the current docs and the others
link with the appropriate prefix.
Filtered out previous versions that include "rc".
The number of versions is kept at 5 (current + 4 recent).
The last five tags (that start with a number) are used as version
numbers and linked to. This updates the sphinx extension so that
every user of the theme gets this info automatically with no need
to update the conf.py on a per-project basis.
This patch removes `MANIFEST.in` file as pbr generates a sensible
manifest from git files and some standard files and it removes
the need for an explicit `MANIFEST.in` file.
subprocess raises OSError if the command it is asked to run isn't found,
so trap that as well as the subprocess-specific error we were already
subprocess.check_output returns bytes, so we end up using '+' on a text
string (CGIT_BASE) and bytes (the output of parsed.path) in
_guess_cgit_link. Make sure we decode 'git_remote' in Python 3.
* Remove usedevelop : only needed when skipsdist
is set to True
* Remove install_command : We can just use the
default, we don't need to override
* Remove setenv : We can just use the default as
we don't need any extra environment variables
* sitepackages : default is already false
Add a configuration option to let projects set the URL to the cgit
browser for their source. Still try to guess at the location based on
our git URL.
The event handler should return a string if it wants to replace the
template, but should otherwise return None and update the context in
In the table of contents the titles are covering words
in the page, this won't be a problem but the directories
that are in the table of contents are considered 1 word
so it does not word wrap automatically