diff --git a/.zuul.yaml b/.zuul.yaml index 6914074..dfe55d1 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -1,9 +1,13 @@ --- - project: + templates: + - build-openstack-docs-pti check: jobs: - - build-openstack-sphinx-docs - openstack-tox-linters gate: jobs: - openstack-tox-linters + post: + jobs: + - publish-stx-specs diff --git a/doc/source/conf.py b/doc/source/conf.py index 28eecf5..0971f04 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -40,8 +40,9 @@ release = u'0.1' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['openstackdocstheme' - ] +extensions = [ + 'openstackdocstheme', +] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -79,7 +80,7 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'openstackdocs' +html_theme = 'alabaster' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/doc/source/index.rst b/doc/source/index.rst index 944d31a..b84bda5 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -2,5 +2,39 @@ StarlingX Specs =============== .. toctree:: + :glob: :maxdepth: 2 :caption: Contents: + +StarlingX Project Specifications +-------------------------------- + +.. toctree:: + :glob: + :maxdepth: 1 + + specs/* + +Approved Specifications +----------------------- + +.. toctree:: + :glob: + :maxdepth: 1 + + specs/approved/* + +Implemented Specifications +-------------------------- + +.. toctree:: + :glob: + :maxdepth: 1 + + specs/implemented/* + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` diff --git a/doc/source/specs b/doc/source/specs new file mode 120000 index 0000000..87a4030 --- /dev/null +++ b/doc/source/specs @@ -0,0 +1 @@ +../../specs \ No newline at end of file diff --git a/specs/STX_Example_Spec.rst b/specs/STX_Example_Spec.rst index 4a59da8..54fe98a 100644 --- a/specs/STX_Example_Spec.rst +++ b/specs/STX_Example_Spec.rst @@ -2,6 +2,7 @@ .. Many thanks to the OpenStack Nova team for the Example Spec that formed the basis for this document. +======================= StarlingX: Example Spec =======================