b0166265a8
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>
44 lines
1.5 KiB
ReStructuredText
44 lines
1.5 KiB
ReStructuredText
========================
|
|
Team and repository tags
|
|
========================
|
|
|
|
.. image:: https://governance.openstack.org/tc/badges/openstackdocstheme.svg
|
|
:target: https://governance.openstack.org/tc/reference/tags/index.html
|
|
|
|
.. Change things from this point on
|
|
|
|
OpenStack Foundation Sphinx Themes
|
|
==================================
|
|
|
|
Theme and extension support for Sphinx documentation that is published by
|
|
OpenStack Foundation projects.
|
|
|
|
OpenStack docs.openstack.org Sphinx Theme
|
|
-----------------------------------------
|
|
|
|
Theme support for Sphinx documentation that is published to
|
|
docs.openstack.org and developer.openstack.org.
|
|
|
|
Intended for use by OpenStack `projects governed by the Technical Committee`_.
|
|
|
|
.. _`projects governed by the Technical Committee`: https://governance.openstack.org/tc/reference/projects/index.html
|
|
|
|
StarlingX docs.starlingx.io Sphinx Theme
|
|
-----------------------------------------
|
|
|
|
Theme support for Sphinx documentation that is published to
|
|
docs.starlingx.io.
|
|
|
|
Intended for use by StarlingX `projects governed by the Technical Steering Committee`_.
|
|
|
|
.. _`projects governed by the Technical Steering Committee`: https://docs.starlingx.io/governance/reference/projects/index.html
|
|
|
|
References
|
|
----------
|
|
|
|
* Free software: Apache License, Version 2.0
|
|
* Documentation: https://docs.openstack.org/openstackdocstheme/latest/
|
|
* Release notes: https://docs.openstack.org/releasenotes/openstackdocstheme/
|
|
* Source: https://git.openstack.org/cgit/openstack/openstackdocstheme
|
|
* Bugs: https://launchpad.net/openstack-doc-tools
|