diff --git a/openstackdocstheme/theme/starlingxdocs/footer.html b/openstackdocstheme/theme/starlingxdocs/footer.html new file mode 100644 index 0000000..0e49375 --- /dev/null +++ b/openstackdocstheme/theme/starlingxdocs/footer.html @@ -0,0 +1,41 @@ + diff --git a/openstackdocstheme/theme/starlingxdocs/header.html b/openstackdocstheme/theme/starlingxdocs/header.html new file mode 100644 index 0000000..336977f --- /dev/null +++ b/openstackdocstheme/theme/starlingxdocs/header.html @@ -0,0 +1,52 @@ +{% if page_source_suffix %}{# an input file was read #} + +{% else %}{# a template was rendered directly #} + +{% endif %} + {% include 'os_search_install.html' %} + diff --git a/openstackdocstheme/theme/starlingxdocs/sidebartoc_menu.html b/openstackdocstheme/theme/starlingxdocs/sidebartoc_menu.html new file mode 100644 index 0000000..451a492 --- /dev/null +++ b/openstackdocstheme/theme/starlingxdocs/sidebartoc_menu.html @@ -0,0 +1,6 @@ + + diff --git a/openstackdocstheme/theme/starlingxdocs/sidebartoc_menu_apiref.html b/openstackdocstheme/theme/starlingxdocs/sidebartoc_menu_apiref.html new file mode 100644 index 0000000..477cece --- /dev/null +++ b/openstackdocstheme/theme/starlingxdocs/sidebartoc_menu_apiref.html @@ -0,0 +1,11 @@ + + diff --git a/openstackdocstheme/theme/starlingxdocs/titlerow.html b/openstackdocstheme/theme/starlingxdocs/titlerow.html new file mode 100644 index 0000000..27c3c25 --- /dev/null +++ b/openstackdocstheme/theme/starlingxdocs/titlerow.html @@ -0,0 +1,20 @@ +
+
+ {%- if theme_sidebar_dropdown == 'os_docs' %} +

{{ title }}

+ {% else %} +

StarlingX API Documentation

+ {%- endif %} +
+
+ {% if prev %} + + {% endif %} + {% if next %} + + {% endif %} + {%- if bug_project %} + + {% endif %} +
+
diff --git a/releasenotes/notes/add-starlingxdocs-10a33318f8630486.yaml b/releasenotes/notes/add-starlingxdocs-10a33318f8630486.yaml index b520791..ef34b04 100644 --- a/releasenotes/notes/add-starlingxdocs-10a33318f8630486.yaml +++ b/releasenotes/notes/add-starlingxdocs-10a33318f8630486.yaml @@ -1,8 +1,8 @@ --- features: - | - Add support for additional themes is included in the package. The - first theme is ``starlingxdocs``. The initial implementation sets up + Add support for including additional themes in the package, starting + with ``starlingxdocs``. The initial implementation sets up the new theme to inherit from ``openstackdocs`` and updates some of the ``openstackdocs`` bits that are hard coded in the Python. diff --git a/tox.ini b/tox.ini index 81a941c..275ae08 100644 --- a/tox.ini +++ b/tox.ini @@ -49,12 +49,24 @@ commands = rm -rf releasenotes/build sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html +[testenv:releasenotes-starlingxdocs] +basepython = python3 +commands = + rm -rf releasenotes/build + sphinx-build -a -E -W -d releasenotes/build/doctrees -b html -D html_theme=starlingxdocs releasenotes/source releasenotes/build/html + [testenv:api-ref] basepython = python3 commands = rm -rf api-ref/build sphinx-build -a -E -W -d api-ref/build/doctrees -b html api-ref/source api-ref/build/html +[testenv:api-ref-starlingxdocs] +basepython = python3 +commands = + rm -rf api-ref/build + sphinx-build -a -E -W -d api-ref/build/doctrees -b html -D html_theme=starlingxdocs api-ref/source api-ref/build/html + [testenv:buildpdf] # Only build PDF and push it to publish-docs folder so that OpenStack # CI jobs will publish it.