Commit Graph

127 Commits (a800d4c3df5bba293fb7af4c5329c9538909b961)

Author SHA1 Message Date
OpenStack Proposal Bot a800d4c3df Updated from global requirements
Change-Id: Ia8a6ecd29abcf831019d00dccab2b09829929529
2017-03-02 17:51:35 +00:00
ricolin 625bcc6778 [Fix gate]Update test requirement
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
Partial-Bug: #1668848

Change-Id: I6b487922bde32b233eaffbcf76a94144bec06837
2017-03-02 18:15:11 +08:00
Beth Elwell b29dc2937e Amended dev documentation side navigation
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
2017-02-22 09:47:38 -05:00
Doug Hellmann 2f8d5756fb add more clear guidelines for when using oslosphinx is appropriate
Based on the branding guidelines linked in this patch, projects that are
not officially under governance should not use the theme in most

Change-Id: Id6ded25a20965803ddbca0c2e587d3f4c476168f
Signed-off-by: Doug Hellmann <>
2017-02-15 11:58:32 -05:00
OpenStack Proposal Bot 63b3002737 Updated from global requirements
Change-Id: I159de927d5f63b363a1e643c661f8f19b386cb4a
2017-02-11 17:50:49 +00:00
OpenStack Proposal Bot dced1da347 Updated from global requirements
Change-Id: Ic6ad4e5907f8f8d67f349396ecfdedf64740cbde
2017-02-10 05:58:09 +00:00
gengchc2 47b6f688ab Use https instead of http for

Change-Id: I5277e07ec42762c06a41d9efe4c6038a9fefb6ef
2017-02-07 10:38:19 +08:00
OpenStack Release Bot 63dda5e0da Update reno for stable/ocata
Change-Id: I261b16afd4f59737dd096fce24a582fa6ccb071a
2017-01-20 19:16:10 +00:00
Eric Brown a45542eadb Remove references to Python 3.4
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
2017-01-17 10:39:15 -08:00
Tony Breeds 8d1cf4f0d8 Add Constraints support
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
2016-12-20 14:34:44 +11:00
OpenStack Proposal Bot a5271974a2 Updated from global requirements
Change-Id: I856b99d980fb4354b7ed8927b70949b8144b46d5
2016-12-02 05:12:39 +00:00
Flavio Percoco f97e6b3a80 Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

To see an example of how this would look like check:


Change-Id: Ibdf60d28bb56c4372a9d8ac76ee3a8196c164523
2016-11-25 13:08:34 +01:00
OpenStack Proposal Bot 07323255f9 Updated from global requirements
Change-Id: I51daf01c62c18a5abb54d431959d6dabd50c3dd9
2016-11-09 04:23:13 +00:00
ChangBo Guo(gcb) e585ff0d86 Add reno for release notes management
The release management team have indicated this is their preferred way
to collect release notes in future.

Closes-Bug: #1634356

Change-Id: I1b07a37eaa57c0f1767a534c6208d62d572a80a4
2016-11-03 14:53:58 +08:00
Jenkins b82f250c2f Merge "Support more notice blocks like important, tip and caution" 2016-10-02 00:36:59 +00:00
OpenStack Proposal Bot f57e2e560a Updated from global requirements
Change-Id: I1cba85e6d8e8a794dae682f39216424402f5a7c3
2016-09-28 16:59:58 +00:00
avnish 030f9ba7bc Update homepage with developer documentation page
Change-Id: I67395d3b1396d177c58c7c0e509455251df97cf5
2016-09-21 15:29:53 +05:30
Akihiro Motoki c6b55af713 Support more notice blocks like important, tip and caution
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
2016-09-15 20:32:27 +09:00
Ondřej Nový 5c765d5561 Fixed AttributeError: 'str' object has no attribute 'decode'
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
2016-07-17 17:32:12 +02:00
David Stanek 3bcdfc6b77 Allow "Other Versions" section to be configurable
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
2016-07-12 16:18:39 +00:00
Jenkins dc8baacfbd Merge "fix other versions sidebar links" 2016-07-12 15:20:41 +00:00
OpenStack Proposal Bot e2ded8e307 Updated from global requirements
Change-Id: Icaf8086589d629798108ead9e1c57e3d1a19cae4
2016-06-21 18:04:46 +00:00
John Dickinson 3fc15a50f6 fix other versions sidebar links
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
2016-06-20 23:07:17 +01:00
Joshua Harlow d901a7bd61 Subprocess returns bytes in py3
When later used the current code will break in
python3 due to:

TypeError: 'str' does not support the buffer

Change-Id: I11572dd510ce8255ed66de56d5d9000755f7fee2
2016-06-01 16:46:04 -07:00
OpenStack Proposal Bot c327f858e6 Updated from global requirements
Change-Id: Ie5922a24122950c6ab82637d818bdac284a469f2
2016-05-17 14:09:18 +00:00
John Dickinson 75cfb9f93b add recent versions links to sidebar
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 on a per-project basis.

Change-Id: I9bf17872bd23bed3cab9b5e2349d615c7001cb66
2016-05-09 14:35:20 -07:00
Eric Brown 8084f2a468 Add version and download badges to README
All the other oslo libraries contain such badges, so might as well
add to oslosphinx too.

Change-Id: I23fa8dc4619940896fb25af39325f076f4dd3e49
2016-02-03 14:49:50 -08:00
Brant Knudson 7de9722551 Correct project source guessing for OpenStack
The links to the project source in all the developer docs are
incorrect. The link for keystone is like

when it should be

See the link to "Project Source" on the left on for example.

Also, developers sometimes use a ".git" URL when they clone so
strip off the .git.

Change-Id: I8e7620119a169e3322d602ea633303cf9f941605
2016-02-02 08:56:12 -06:00
OpenStack Proposal Bot 6903e98bfb Updated from global requirements
Change-Id: I086cc0a93b00abc16c2bf9aa03a95d23c8455d44
2016-01-16 03:31:36 +00:00
OpenStack Proposal Bot b73bfc5cc9 Updated from global requirements
Change-Id: Ifb3265b0f0849e5e9aac97574ae457a4e4415130
2015-12-15 18:16:34 +00:00
Jenkins 422df5892c Merge "Deprecated tox -downloadcache option removed" 2015-12-14 05:03:36 +00:00
Ondřej Nový bd5fad6e3f Deprecated tox -downloadcache option removed
Caching is enabled by default from pip version 6.0

More info:

Change-Id: Ic8aa835bbc689246afa8fa8ebd9420c1bb1327a9
2015-12-11 21:23:20 +01:00
sonu.kumar ea01f15dfe Removes as it is not needed explicitely by PBR
This patch removes `` file as pbr generates a sensible
manifest from git files and some standard files and it removes
the need for an explicit `` file.

Change-Id: I38b985cc915cbccfa6ba83ae0cffbd72128f146e
2015-12-11 16:25:34 +05:30
briancurtin 2fbfcf568f Use proper decode function name.
os.fdecode is not a real thing, os.fsdecode is.

Change-Id: I20b3b6d15b7d5775e1f6f97190d9acc62ca3a4ca
2015-12-08 15:27:52 -06:00
Doug Hellmann f8d71ac5ad trap errors from git not being present
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

Change-Id: Ieb9c7f3ccc307250847104a7f97cfa28603fcf5d
Closes-Bug: #1521541
2015-12-01 16:34:54 +00:00
OpenStack Proposal Bot 23539cbb14 Updated from global requirements
Change-Id: I97cb7c94fb4d2b23a289fd05ed5e1060a064118a
2015-11-27 22:41:34 +00:00
Cyril Roelandt 10d5529934 Fix a string vs bytes issue in _guess_cgit_link
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
2015-11-23 15:06:06 +01:00
ChangBo Guo(gcb) da4cfa3f97 Remove Python 2.6 classifier
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
2015-11-17 15:47:24 +08:00
Jenkins 2378e5a9d7 Merge "cleanup tox.ini" 2015-11-17 01:50:18 +00:00
Doug Hellmann 0b555a001f fix html context event handler
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
2015-11-17 01:06:00 +00:00
Davanum Srinivas a3f3bf8b1d cleanup tox.ini
* 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
2015-11-16 00:25:18 +00:00
Doug Hellmann c383e0026a add config option to point to the cgit browser
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
2015-10-16 20:40:02 +00:00
Doug Hellmann cd2674bb95 fix html-page-context event handler
The event handler should return a string if it wants to replace the
template, but should otherwise return None and update the context in

Change-Id: Ic4b19c7d19eda866ba139913cf817c99a65c8c08
Closes-Bug: #1505311
2015-10-12 19:50:40 +00:00
OpenStack Proposal Bot 53c4ae72e9 Updated from global requirements
Change-Id: Ib8e15a9f3da8800687d4244540b7a8aa902e5d14
2015-10-09 05:04:02 +00:00
Davanum Srinivas 014df1a174 No need for Oslo Incubator Sync
We can remove openstack-common.conf as we don't
sync any code from oslo-incubator any more.

Change-Id: I600132f6c59bc8adf06c1edbe488fba0d5ee795b
2015-10-04 19:40:10 -04:00
Javier Pena 2525bb98d1 Make urlparse import Python3-compatible
urlparse moved to urllib.parse, so the current code fails in
Python3. Using six to ensure compatibility.

Related-Bug: #1426898

Change-Id: I9297c886dcc361238e942cb8162f589072001094
2015-09-28 11:34:24 +02:00
Jenkins b0f3ed9cca Merge "Titles in table of contents continue into the page" 2015-09-25 21:00:11 +00:00
Javier Pena 36dd92b1e1 Fix subprocess exception name added code using
subprocess.CheckedProcessException, which does not exist. From
the Python documentation, it should be
subprocess.CalledProcessError [1]

[1] -

Change-Id: I0e03f048a33b1b919e38d22038650a633b8ac5fd
2015-09-25 16:25:14 +02:00
THOMAS J. COCOZZELLO ff59f302c4 Titles in table of contents continue into the page
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
2015-09-25 09:09:28 -05:00
Jenkins 6ffe7dd4f3 Merge "add link to project source in navigation sidebar" 2015-09-25 09:55:19 +00:00