Since pbr already landed and the old version of hacking seems not
work very well with pbr>=2, we should update it to match global
requirement.
Partial-Bug: #1668848
Change-Id: I6b487922bde32b233eaffbcf76a94144bec06837
Amended developer documentation side navigation to add an option for
clearly returning to the project developer documentation home page.
Previously it was possible to return to the home page by clicking
'table of contents' however this is not obvious and makes it hard
to get around the complete project documentation once you have left
the homepage.
This patch removes the link from 'table of contents' which is
misleading, and a link is added beneath this header to say 'Return
to project home page'.
Change-Id: I7cf96acead62f00224ca9217a80760b4a65d42d6
Closes-bug: #1666323
Based on the branding guidelines linked in this patch, projects that are
not officially under governance should not use the theme in most
circumstances.
Change-Id: Id6ded25a20965803ddbca0c2e587d3f4c476168f
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Now that there exists only a gate job for Python 3.5 and not 3.4,
we should remove those references to the 3.4 that is untested.
Change-Id: I5ca7599f52f2f091c15decce324799a5502ed144
Adding constraints support to libraries is slightly more complex than
services as the libraries themselves are listed in upper-constraints.txt
which leads to errors that you can't install a specific version and a
constrained version.
This change adds constraints support by also adding a helper script to
edit the constraints to remove oslosphinx.
Change-Id: I3daafcf22e2d9a1cd73d389debe3b27eccc91910
The release management team have indicated this is their preferred way
to collect release notes in future.
Closes-Bug: #1634356
Change-Id: I1b07a37eaa57c0f1767a534c6208d62d572a80a4
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.
Change-Id: I3e1db551b05fa681520763c24e2576f9ad5379d8
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.
Change-Id: Ibd2f556355a6413beb21473ebfca3b836cbc1d73
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
opt-in behavior.
Change-Id: Ic4b47b19aa9db38557c37aed7722174b7dbdf4a1
Closes-Bug: #1599260
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).
Closes-Bug: #1589731
Change-Id: I3a2e219913fc2c89634bcc2a757ccb4d3510883a
When later used the current code will break in
python3 due to:
TypeError: 'str' does not support the buffer
interface
Change-Id: I11572dd510ce8255ed66de56d5d9000755f7fee2
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.
Change-Id: I9bf17872bd23bed3cab9b5e2349d615c7001cb66
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.
Change-Id: I38b985cc915cbccfa6ba83ae0cffbd72128f146e
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
catching.
Change-Id: Ieb9c7f3ccc307250847104a7f97cfa28603fcf5d
Closes-Bug: #1521541
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.
Change-Id: I9e846e2192ead41ca2328b8aa20994742096c51e
Closes-Bug: #1517525
We have decided to remove Python 2.6 support, this commit
removes Python 2.6 classifier before dropping any Python
2.6 support in code.
Change-Id: I31d54e5fb1f18e49df42fef2863e70af6b2fdea1
The event handler should return a replacement template *name* or None.
Since we don't want to change the template, return None.
Change-Id: I3012ad22505230c488aa4babbd4141d903b7ab0d
Closes-Bug: 1516834
* 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
Change-Id: Id13307a8f7c21496e1d5aad20cd9e2146b8f2fbd
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.
Change-Id: I11455f8a137a029c28a864eb555f69f6c282840b
The event handler should return a string if it wants to replace the
template, but should otherwise return None and update the context in
place.
Change-Id: Ic4b19c7d19eda866ba139913cf817c99a65c8c08
Closes-Bug: #1505311
urlparse moved to urllib.parse, so the current code fails in
Python3. Using six to ensure compatibility.
Related-Bug: #1426898
Change-Id: I9297c886dcc361238e942cb8162f589072001094
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
Change-Id: I763aa1ba4418be1ea70d1ff48a321971630ec6e4
Closes-Bug: 1498654
OpenStack Proposal Bot
OpenStack Release Bot