From 6413ec8e86c2f5a32915d66cdd6bb890929d062e Mon Sep 17 00:00:00 2001 From: Martin Kopec Date: Wed, 15 Sep 2021 17:49:51 +0000 Subject: [PATCH] Publish docs to docs.opendev.org docs.opendev.org will provide easier access to the doc pages in comparison to the Gitea (opening the doc files in the repo). Change-Id: Iecc6d745f1a35e701ff86060169c489556cac9c3 --- doc/requirements.txt | 1 + doc/source/conf.py | 12 +++-- doc/source/guidelines/index.rst | 43 +++++++++++++++++ doc/source/index.rst | 81 ++++++++++----------------------- doc/source/process/index.rst | 15 ++++++ doc/source/schema/index.rst | 26 +++++++++++ tox.ini | 2 + zuul.d/projects.yaml | 7 ++- 8 files changed, 124 insertions(+), 63 deletions(-) create mode 100644 doc/source/guidelines/index.rst create mode 100644 doc/source/process/index.rst create mode 100644 doc/source/schema/index.rst diff --git a/doc/requirements.txt b/doc/requirements.txt index 025ea152..bfc0fd99 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -4,3 +4,4 @@ doc8 jsonschema Sphinx sphinxcontrib.datatemplates +openstackdocstheme>=2.2.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 6d7556cd..f6ec1c0e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -32,10 +32,14 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.viewcode', 'sphinxcontrib.datatemplates', + 'openstackdocstheme', ] todo_include_todos = True +# openstackdocstheme options +openstackdocs_repo_name = 'openinfra/interop' + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -49,7 +53,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'defcore' +project = u'interop' copyright = u'OpenStack Contributors' # The language for content autogenerated by Sphinx. Refer to documentation @@ -93,7 +97,7 @@ man_pages = [] # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'nature' +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 @@ -163,7 +167,7 @@ html_use_index = False #html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'defcore' +htmlhelp_basename = 'interop' # -- Options for LaTeX output -------------------------------------------------- @@ -182,7 +186,7 @@ latex_elements = { # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'defcore.tex', u'OpenStack Interop WG Documentation', + ('index', 'interop.tex', u'OpenStack Interop WG Documentation', u'OpenStack Foundation', 'manual'), ] diff --git a/doc/source/guidelines/index.rst b/doc/source/guidelines/index.rst new file mode 100644 index 00000000..4094c324 --- /dev/null +++ b/doc/source/guidelines/index.rst @@ -0,0 +1,43 @@ +======================= +Guideline Documentation +======================= + +Latest Guideline +---------------- +.. toctree:: + :maxdepth: 1 + :includehidden: + + all.2020.11 + + +Proposed Guideline +------------------ + +.. toctree:: + :maxdepth: 1 + :includehidden: + + all.next + + +Previous Guidelines +------------------- + +.. toctree:: + :maxdepth: 1 + :includehidden: + + all.2020.06 + all.2019.11 + all.2019.06 + all.2018.11 + 2018.02 + 2017.09 + 2017.01 + 2016.08 + 2016.01 + 2015.07 + 2015.05 + 2015.04 + 2015.03 diff --git a/doc/source/index.rst b/doc/source/index.rst index 81120bf0..98f657a8 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,63 +1,30 @@ .. OpenStack Defcore documentation master file -Contents: +Interop Working Group Documentation +=================================== -===================== -Process Documentation -===================== +This Committee was formed during the OpenStack Ice House Summit in Hong Kong +by Board Resolution on 11/4. + +Interop Working Group sets base requirements by defining: + +1. capabilities, +2. code and +3. must-pass tests for all OpenStack products. + +This definition uses community resources and involvement to drive +interoperability by creating the minimum standards for products labeled +"OpenStack." + +Our mission is to define "OpenStack Core" that is supported by all +implementations as chartered by the by-laws. + +Content: +-------- .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - process/2021A.rst - -===================== -Schema Documentation -===================== - -.. toctree:: - :maxdepth: 1 - - schema/2.0.rst - -================= -Active Guidelines -================= - -.. toctree:: - :maxdepth: 1 - - guidelines/2017.01.rst - guidelines/2017.09.rst - -================== -Proposed Guideline -================== - -.. toctree:: - :maxdepth: 1 - - guidelines/next.rst - -=================== -Inactive Guidelines -=================== - -.. toctree:: - :maxdepth: 1 - - guidelines/2015.03.rst - guidelines/2015.04.rst - guidelines/2015.05.rst - guidelines/2015.07.rst - guidelines/2016.01.rst - guidelines/2016.08.rst - -================================ -Interoperability Issues Reports -================================ - -.. toctree:: - :maxdepth: 1 - - periodic_reports/fall_2016.rst + process/index + schema/index + guidelines/index diff --git a/doc/source/process/index.rst b/doc/source/process/index.rst new file mode 100644 index 00000000..9e5e1e1b --- /dev/null +++ b/doc/source/process/index.rst @@ -0,0 +1,15 @@ +===================== +Process Documentation +===================== + +.. toctree:: + :maxdepth: 2 + :includehidden: + + CoreDefinition + DesignatedSections + GovernanceProcess + Lexicon + TrademarkProgram + 2021A + procedure diff --git a/doc/source/schema/index.rst b/doc/source/schema/index.rst new file mode 100644 index 00000000..b22c200e --- /dev/null +++ b/doc/source/schema/index.rst @@ -0,0 +1,26 @@ +==================== +Schema Documentation +==================== + +Latest Schema +------------- + +.. toctree:: + :maxdepth: 1 + :includehidden: + + 2.0.rst + + +Previous Schemas +---------------- + +.. toctree:: + :maxdepth: 2 + :includehidden: + + 1.6.rst + 1.5.rst + 1.4.rst + 1.3.rst + 1.2.rst diff --git a/tox.ini b/tox.ini index 75521550..91cac0d4 100644 --- a/tox.ini +++ b/tox.ini @@ -19,6 +19,8 @@ commands = doc8 -e .rst doc/source [testenv:docs] +deps = -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} + -r{toxinidir}/doc/requirements.txt commands= sphinx-build doc/source doc/build/html diff --git a/zuul.d/projects.yaml b/zuul.d/projects.yaml index 169ee32b..41d7c944 100644 --- a/zuul.d/projects.yaml +++ b/zuul.d/projects.yaml @@ -1,8 +1,7 @@ - project: - templates: - - build-openstack-docs-pti check: jobs: + - opendev-tox-docs - openstack-tox-pep8 - interop-tempest-consistency: # Define a list of irrelevant files to use everywhere else @@ -26,6 +25,10 @@ irrelevant-files: *interop-irrelevant-files gate: jobs: + - opendev-tox-docs - openstack-tox-pep8 - interop-tempest-consistency: irrelevant-files: *interop-irrelevant-files + promote: + jobs: + - opendev-promote-docs