Commit Graph

13 Commits

Author SHA1 Message Date
Stephen Finucane 6676aa9256 Retire oslosphinx
Change-Id: I8c132b41ac325b3ad9c420df583d19b08c18f690
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Closes-Bug: #1713543
Depends-On: https://review.openstack.org/#/c/649954/
2019-04-04 09:53:27 +00:00
zhouxinyong e02631f2ec Applying the HTTPS protocal in usage.rst.
To keep the website in this file be more robust,we'd better update the 
links to HTTPS type

Change-Id: I0876c1bc076443fcdeb5d8a01ed5145376ee6866
2018-12-06 17:47:05 +00:00
lingyongxu 1cb173e6a7 Switch from oslosphinx to openstackdocstheme
As part of the docs migration work[0] for Pike we need to switch to use
the openstackdocstheme.

[0]https://review.openstack.org/#/c/472275/

Change-Id: Ib35eb111e766b244d03eb9b52badb54d08efb07b
2017-07-06 09:28:56 +08: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
circumstances.

Change-Id: Id6ded25a20965803ddbca0c2e587d3f4c476168f
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-02-15 11:58:32 -05:00
gengchc2 47b6f688ab Use https instead of http for git.openstack.org
Trivialfix

Change-Id: I5277e07ec42762c06a41d9efe4c6038a9fefb6ef
2017-02-07 10:38:19 +08:00
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
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
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 6ebaef6ba4 clean up documentation titles and intros
Change-Id: I9f1bf4e912e53500f603cecb23f86b48d5dbc159
2015-09-24 19:42:39 +00:00
Doug Hellmann fa83ee0dc5 add pbr-generated release history to the doc build
Change-Id: I5d24d269a3861c56df0a08fb7e1dcc86e1336e36
2015-09-24 19:41:29 +00:00
Doug Hellmann 4ce81f85fb Add an extension for validating blueprint names
This new extension requires spec filenames to match blueprint names in
the relevant project. This is based on work originally done in
oslo-specs under https://review.openstack.org/#/c/138392/

Change-Id: Ifd58f4f71f661229f09ecf01047bc7a7b1dc0b08
2014-12-09 15:49:01 -05:00
Doug Hellmann acd90677ef Tighten up documentation
Remove some mostly empty pages and add a few section headings.

Change-Id: I5f0b99ce7573c60b741dd726e55f28cf3bf9f7fc
2014-10-21 14:56:34 -04:00
Davanum Srinivas 446a8dc6ca Add initial cut for documentation
Closes-Bug: #1364141

Change-Id: I137d244a50088918e2356da883d09f5d95da8bca
2014-09-18 12:31:30 -04:00