starlingx/docs
Code Issues Proposed changes

Changes to support conditionalizing rST 'substitutions'

Browse Source 
Base set of substitutions added for organization name, product
names, document names amd rubrics.

This amendment adds a substitition for StarlingX OpenStack.

Change-Id: I236c193ae3a526a3903afa23a0a86db7d61f1244
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
This commit is contained in:
Ron Stone 2020-08-28 15:14:53 -04:00
parent 965e7aebe6
commit d99ab454f1
3 changed files with 48 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/conf.py
View File

@ -12,8 +12,8 @@
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
import os
import sys
# sys.path.insert(0, os.path.abspath('.'))
@ -71,6 +71,12 @@ openstackdocs_auto_name = False
openstackdocs_bug_project = 'starlingx'
openstackdocs_bug_tag = 'stx.docs'
# Common substitution strings such as organization, product
# and document names.
rst_prolog = open('./shared/strings.txt', 'r').read()
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for

39
doc/source/shared/strings.txt Normal file
View File

@ -0,0 +1,39 @@
.. Common string substitutions for brand customization.
.. NOTE: Do not use underscores in these substitution names.
.. For more information, see
.. https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#substitutions
.. Organization name
.. |org| replace:: StarlingX
.. Short and long product names such as "StarlingX" and "Acme Co. StarlingX"
.. |prod| replace:: StarlingX
.. |prod-long| replace:: StarlingX
.. |prod-os| replace:: StarlingX OpenStack
.. Guide names, will be formatted in italics by default.
.. |node-doc| replace:: :title:`StarlingX Node Configuration and Management`
.. |planning-doc| replace:: :title:`StarlingX Planning`
.. |sec-doc| replace:: :title:`StarlingX Security`
.. |inst-doc| replace:: :title:`StarlingX Installation`
.. |stor-doc| replace:: :title:`StarlingX Storage Configuration and Management`
.. |intro-doc| replace:: :title:`StarlingX Introduction`
.. |fault-doc| replace:: :title:`StarlingX Fault Management`
.. |sysconf-doc| replace:: :title:`StarlingX System Configuration`
.. |backup-doc| replace:: :title:`StarlingX Backup and Restore`
.. |deploy-doc| replace:: :title:`StarlingX Deployment Configurations`
.. |distcloud-doc| replace:: :title:`StarlingX Distributed Cloud`
.. |usertasks-doc| replace:: :title:`StarlingX User Tasks`
.. |admintasks-doc| replace:: :title:`StarlingX Administrator Tasks`
.. |datanet-doc| replace:: :title:`StarlingX Data Networks`
.. Task-oriented headings that should not appear in TOC
.. These are used with the .. rubric:: directive. For example:
.. .. rubric:: |postreq|
.. |context| replace:: About this task
.. |prereq| replace:: Prerequisites
.. |proc| replace:: Procedure
.. |postreq| replace:: Postrequisites
.. |result| replace:: Results
.. |eg| replace:: Example

2
tox.ini
View File

@ -16,7 +16,7 @@ deps =
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-r{toxinidir}/doc/requirements.txt
commands =
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html {posargs}
[testenv:api-ref]
deps = {[testenv:docs]deps}