Commit Graph

21 Commits

Author SHA1 Message Date
Andreas Jaeger d3cdb8689b Change name of OpenStack Foundation
OpenStack Foundation got renamed to Open Infrastructure Foundation,
follow the rename and update links as well.

Remove no longer working links.

Change-Id: Iee3bb16fb6554ad80a3263f4f364976bcb8c88e1
2020-10-22 09:51:36 +02:00
Andreas Jaeger 2d76fd9cff Update for OpenDev change
Use the new OpenDev URLs everywhere, follow move of repositories.

Change-Id: I3dd8c6deff91c4cc3b8958977e73f371bdeb82a0
2019-04-21 14:27:39 +00:00
Dean Troyer b0166265a8 Add starlingxdocs theme support
At the PTG the Docs team and dhellmann decided that openstackdocstheme
was the proper place to keep the modifications required to build
a theme for StarlingX and other OpenStack Foundation-related projects.

This is a minimal set of changes to support a second theme with a couple
of visual changes thrown in to make obvious that the correct theme
is being used. The remainder of the visual work will follow.
Both PNG and SVG versions of the logo are included.

Add an additional jobs to build the docs and PDF with the new theme.

Modify the wording in README.rst and the docs index page regarding
the distinction between openstackdocstheme the module and openstackdocs
and starlingxdocs the themes and their intended uses.

There are a number of hard-coded OpenStack-isms that will eventually
need to be addressed.

Change-Id: I594136a0ea66d61f60dafc6a853137470efc7d42
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-05 06:32:51 +00:00
zhangdebo1987 0e3819135c Update links in README
Change-Id: Iba70d7308500e7d7d0093d12364141326b87c23d
2017-08-03 15:55:21 +08:00
Doug Hellmann fd53ed49ce move documentation from readme to sphinx tree
Move the existing test docs into a subdirectory and move the setup
details from the README to docs/source/index.rst.

Change-Id: Ic66247a1d5527cf1ba34f3b1561de6a027e12050
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-27 13:36:51 -05:00
Doug Hellmann 780a0f1764 automate some of the extension setup
Remove the code that was trying to force openstackdocs to be the
theme. It was using the wrong name anyway, so it didn't work, and we
don't want to use that approach any more.

Add configuration options to make it easier to pass the git repository
and bug tracker information.

Add an event processor to update the html page context for each
page. Include the gitsha by looking at the repository. Include the
giturl by looking at the configuration option for the repo name and
building the URL from it.

Include the bug project and tag values based on the configuration
options.

Update the instructions for enabling the theme to include adding the
module to the list of extensions to turn on all of the above.

Add the openstackdocs theme automatically when the extension is
initialized.

Change-Id: Icf3a40ed104cfd828f532f6f2b112ed02f996ff5
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-24 07:20:01 +00:00
Akihiro Motoki 65c99f6624 README: Update configuration of openstackdocstheme
The configuration guide in README.rst looks out-of-date.

Change-Id: I4bbd2298c92aa5808919568642afd000ad6ddfd7
2017-05-18 08:26:02 +09:00
Brian Moss 52b3cd4907 Update Launchpad info
Tools and theme bugs are now being tracked in
the openstack-doc-tools project on Launchpad.

Change-Id: Ib8bcaab16a56ded4b286214ed5d5cddcdcd2263e
2017-02-17 10:26:28 +10:00
Leif Madsen a4a2ed7f99 Add note in README about Python 3 changes
Add a node that explains that for Python 3 you'll need to add a
.decode() function in the gitsha command. Also, note that you
need to import subprocess in the conf.py file.

Change-Id: I1eb42738be74de96fae0940f3e97283351602e95
2017-01-31 15:33:42 +00:00
Flavio Percoco 3b8e21c961 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:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

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

b'https://gist.github.com/4f7ebfa0c85e8007a41d4bc5c8f4ec97\n'

Change-Id: If173ce9a047c6df285283a735ce15a90d4f7cea3
2016-11-25 14:46:24 +01:00
Petronio Carlos Bezerra ebf3a775ba Broken Link
Fixing broken link.

Change-Id: I68e32ab77b0eec5781721d644ab77ffbd845a549
2016-07-01 16:59:22 +00:00
Anne Gentle cd2b088e16 Clarify uses for this theme
Change-Id: Ib31c837f4b4c875bd40e070118603df71eed5187
2016-03-21 15:59:16 -05:00
Harshada Mangesh Kakad aa3200f1cb Replace deprecated library function os.popen() with subprocess
os.popen() is deprecated since python 2.6.
Resolved with use of subprocess module.

Change-Id: Ia7e19f82bedfa43cd8f98d03fb5a0bb0860d0221
Closes-Bug: #1529836
2016-01-14 05:19:11 -08:00
Jenkins 253a10f64b Merge "Use os.getcwd() instead of shelling out to run pwd" 2015-05-26 00:37:31 +00:00
Doug Hellmann 07bf89a98e Use os.getcwd() instead of shelling out to run pwd
Change-Id: I78d8b41c43fe957684391c100fb61644a52887b1
2015-05-22 16:38:43 -07:00
Peter Tran 6dd1f7d517 "Report a bug" link in HTML manuals automatically fills in bug's tag
The "Report a bug" link in the HTML manuals populate information about the page.
Since manuals within openstack-manuals project have their own tag within
launchpad, this patch automatically tags the bug using a tag defined in conf.py.

Change-Id: I3c9214a4f5a00648d325b4acaa493057ab0e4821
Closes-Bug: #1342373
2015-05-22 14:17:55 -07:00
Anne Gentle 119b88f13b Document conf.py variables
Adds information about conf.py variables that must be included for log-a-bug

Change-Id: I70fd2bb31d7eeb6a32f9df43ef6c729225169e37
2015-04-22 21:05:26 +02:00
Doug Hellmann 92cb5c8ddd Add instructions to the README
Add instructions for using the package to the README.

Change-Id: I51315d65fe29160bf03fb6f45ed6ae88133d4cb5
2015-02-21 10:49:08 +01:00
Anne Gentle c82a48d0d0 Merge branch 'master' of https://github.com/annegentle/openstackdocstheme
Conflicts:
	README.rst
	conf.py
	setup.cfg
2015-01-28 14:01:32 -06:00
Anne Gentle 5150996122 Adds rearranged files for rename to openstackdocstheme 2015-01-28 13:56:35 -06:00
Anne Gentle cf9c89fa9b Starting point for Sphinx theme for docs.openstack.org content 2015-01-20 10:49:21 -06:00