Add a check for duplicate :abbr: anchor strings to prebuild phase
and error on duplicates.
Change-Id: I034c321a3c83aa4c0cbcf551fd90161e9e221c18
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Strip empty rows from HTML output tables. Max width 10 columns.
|hide-empty-rows| must be present in corresponding rst file.
This is a post-build clean-up step for tables with conditional
content that renders as empty rows.
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Ia65cc0a945d0ed8955c2a5d9bb68649d2280d27d
Enable HTML tabs in output pages. This is initially for use differentiating virtual
from bare-metal instructions in a consolidated Install doc. Since virtual content is
currently StarlingX-only, content must be conditionalized as in:
.. present tabbed content choice to StarlingX builds
.. only:: virtual
.. tabs::
.. tab:: Virtual
Apples are green, or sometimes red.
.. tab:: Bare Metal
.. bare-metal-pear-begin
Pears are green.
.. bare-metal-pear-end
.. Present bare-metal only to non-StarlingX builds as non-tabbed content
.. only:: partner
.. include:: this-file.rst
:start-after: bare-metal-pear-begin
:end-before: bare-metal-pear-end
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Ib65cf59f510e685a82c3d1ab046cb656d0f2fba1
Add a tox job to output docs as a single HTML page. This is mostly
for use by writers who need to reliably search globally for
content when making updates. Can be printed to PDF using browser
Print
Abstract pre and post phases for reuse in multiple builds.
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Ic03c82ac91a69f242c1b192e10fb19ef30846e2f
The dev environment used by some docs developers uses
an old version of tox, and does not support the
allowlist_externals entry required by tox 4.
The version of tox used by some other developers cannot
support tox.ini that contains both allowlist_externals and
whitelist_externals in the same file.
The fix for now is to stay with whitelist_externals and tox<4
This fix mostly reverts and re-works these two commits
https://review.opendev.org/c/starlingx/docs/+/869229https://review.opendev.org/c/starlingx/docs/+/868621
Partial-Bug: #2000399
Signed-off-by: Al Bailey <al.bailey@windriver.com>
Change-Id: Ib8a5eea5d27e7b7347bc717d11f9dc5a0be4f396
When updating the tox.ini files to support tox 4 the older
tox 2.9 support became broken. That version of tox is
still being used by several contributors to this repo.
The proposed change is to manually alias whitelist_externals
to allowlist_externals in the tox.ini sections.
Partial-Bug: #2000399
Signed-off-by: Al Bailey <al.bailey@windriver.com>
Change-Id: I2cbd04b8170ae30cbfa8e9e93cc67af54e0cf602
Pull DS Verified Hw table into topic as html chunk.
Trigger post-build clean-up.
Add support for upcoming release.
Resolve merge conflict.
Restore verified table in upstream context.
Remove illegal blank line.
Uncomment post-processing file.
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Ib035e932c79723ccbe46fa14928df7b51c247765
This change will allow this repo to pass zuul now
that this has merged:
https://review.opendev.org/c/zuul/zuul-jobs/+/866943
Tox 4 deprecated whitelist_externals.
Replace whitelist_externals with allowlist_externals
Partial-Bug: #2000399
Signed-off-by: Al Bailey <al.bailey@windriver.com>
Change-Id: Idd6eab4a194066072ef362be970e5b982665bf43
Refresh existing HW listing
Add support for verified HW table
Resolve merge conflict
Update table label
Commenting out raw html pull. Sphinx is not conditionalizing this.
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I02abaf299a8010ee562776eda094d116fb8113e2
Add new items with example to sections.
Add new example figure.
Fix numbering.
Resize figures to fit the page.
Update log files name.
Add item 4 in include file.
RS> Conditionalize 'dcmanager subcloud list' states for
various run scenarios
RS> Move step from .. only:: block to .. include::
RS> Pre-process included blocks in non-block context
RS> Remove debug message from script
EG> Added example
EG> Fixed caution box
Story: 2010271
Task: 46946
Signed-off-by: Elisamara Aoki Goncalves <elisamaraaoki.goncalves@windriver.com>
Change-Id: I3791a23fefba8d9d428ae208b3bfcb9274d49278
Open 700 series alarms from 75* > 7**. "Context" field will filter
platform/openstack output.
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Ida65b8fee894f288a874a4312f7ded641ae019c5
Call script as arg to bash in case shebang fails
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: If0adef0715ebf2071079adbc02dee66e34143603
Configure tox+content to fetch event and convert alarms and logs
to rst for use in build.
Handle non-existant tmp dir in zuul builds
Add static events.yaml for CI/CD testingx
Generalize label construction to prevent namespace conflicts
Consume events directly from fm repo (required changes merged)
Update logs template for legibility.
Add clean up for temporary rst files.
Point parser at dynamically downloaded events file
Restore logs template
Note: This review deletes static alarm and log files
Note: This review excludes alarm files from git as they are now
build-time temp files.
Note: This review uses a static copy of events.yaml to pass tox
until the dep. below is met. It will need reconfiguration
at that time.
Depends-On: https://review.opendev.org/c/starlingx/fault/+/863574
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I0bb8d0a77b9d3cf22b33f8930c569b3e70b7291c
Pull arbitrary files into the build.
Use swapable configs to specify source and dest.
Remove echo used for testing.
Clean up comments
Clean up usage output
Add missing semicolon
Standardize arg handling
Add flag to skip branch lookup & dl from non-git URLs
Delete commented/obsolete lines
Troubleshoot zuul -1:
Failing on "grep '^\[testenv:pdf-docs\]' src/opendev.org/starlingx/docs/tox.ini"
- this change does not touch tox.ini
- other reviews are passing with the same tox file
- removing new subdir named 'configs' on hunch that this may be a
reserved name?
- Adjust linters to relax line lenght restrition on yaml files
Update target location for alarms and logs.
Delete temporary events dl used in testing
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I8ffff95688bf9a3a93e7e5a01bacbf132abe312d
Fix for a recent change to openstack upper-constraints that is
incompatible with pinning sphinx at 4.2.0
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I96c6c860f2cefe876f9170063c72c6b17224eaf1
This script is being used in repos where the html output
path differs. Pass as arg in tox.ini.
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I6d2643e9a810e1054feaefb2f46612c4e8f8789a
Compare logs for two arbitrary branches by author and date range
and filter for unmatched subject lines with pick notation e.g.
(dsR6,r5).
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I45a1fe29f861fe8a749526a63a1f86d91efca3a3
Continuation of https://review.opendev.org/c/starlingx/docs/+/826142
Move sphinxcontrib.spelling dependency out of 'docs' build env
Minor updates to spelling_wordlist.txt for testing
Note: shared/strings.txt do not current load into spellcheck env. This causes
numerous warnings but does not interfere with spell check. More investigation
TBD.
Note above no longer relevant. Fixed.
Incorporated Patchset 1 review comments.
Remove terms from wordlist
Exclude Chinese doc from EN-US spellcheck
Updates to wordlist
Resolve merge conflicts.
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I78639c2dc468f9132297b75280ba373d05c28233
- spellcheck
- linkcheck
Implemented as distinct environments to prevent premature exits on error.
Add 'enchant' C library via bindep
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I61912b7601719649655dd9dae86800f8b33d58f8
Extend newfile script to generate unique filenames for
include files.
Update instructions in Contributor guide
Include correct version of new-topic.sh
Fix script output in Contributor guide
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I049adb2a8b8b028c45e2fc4f951db664e4777550
Upstream constrainsts change here invalidates sphinx version upper limit:
https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt
This change resets constraint and removes dependancy on upper-constraints.txt
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I5bf939734cbb386c95de2328bea6c0c89e7ab3ee
As discussed, a simple script to create stubs with unique names and labels.
Prefix name of index files with "index-" to distinguish them from 'regular'
files.
Added missing "::" to templated rubrics.
Remove unneeded echo.
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I8f7dd8f4a57655032de6913d4570f5ca5c2b9338
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Additional conditionalization and corrections.
Patchset 1 review updates.
Added Installation appendixes
Adjusted tox.ini for contitionalized openstack blocks
Patchset 2 review comments.
Patchset 3 review comments and tried to make changes more globally in edited files.
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Icca40bc8c8c46ca1f3f38f5e4a63f5bb466b19bc
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
There are some files that was added new content.
Signed-off-by: Rafael Jardim <rafaeljordao.jardim@windriver.com>
Change-Id: I5489abf08647014030f53849120c1c42a798cdfe
Restarting review https://review.opendev.org/c/starlingx/docs/+/773155
Adding htmlChecks.sh to tox.ini. Script will run post-build checks for
HTML formatting issues not reported by sphinx.
Per 773155 review of tox failure, updated tox.ini to pass script to bash.
Script was executable in previous review but failed remote runs.
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I603c724fcac567006e20244cffa15ee2860a7b68
Adding --keep-going arg.
With -W option, keep going processing when getting warnings to the end of build, and sphinx-build exits with exit status 1.
This is useful to address multiple build errors in parallel instead of a series of build/fail cycles.
Signed-off-by: Stone <ronald.stone@windriver.com>
Change-Id: I0e73ec8e9d6e5f32a37ee0cbe4e113d024cc485b
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>
Several reorgs:
* setup.cfg/setup.py must be in top-level dir so that siblings
(installing for example openstackdocstheme from source instead of
pip) works.
* Update openstackdocstheme version (see below)
* Remove unused entries from setup.cfg
* Remove py27 code from setup.py
* Update tox.ini for a py3 only world and cleanup
Switch to openstackdocstheme 2.2.1 version. Using
this version will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Disable openstackdocs_auto_name to use 'project' variable as name.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I27039f9dc52c3e6c9e667b5699172d0f834e8f6b
In the file,the basepython value has been
set for the specified virtual environment.
So we don't need to set up an override in
testenv.
For this change, we executed the tox
command for testing to ensure that the
modification did not produce errors.
Change-Id: I290867f0b062e5b3b6327fb44dbf759bd857c86d
Closes-Bug: #1835394
We want to default to running all tox environments under python 3, so
set the basepython value in each environment.
We do not want to specify a minor version number, because we do not
want to have to update the file every time we upgrade python.
We do not want to set the override once in testenv, because that
breaks the more specific versions used in default environments like
py35 and py36.
Change-Id: I4dae808f500bd5c8caa462a2d1deae157adff29d
Closes-Bug: #1802032
The project-specific docs are published independently so we need
to maintain the links into those subtrees (/stx-*), also
for the api-ref (/api-ref/stx-*) and releasenotes (/releasenotes/stx-*).
Also add docs env to the default list in tox.ini.
Change-Id: If68e6c984d684af05124b3252a8ff3c4b44b6d82
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
Baseline changes to comply with OpenStack API documentation
from OpenStack Documentation Contributor Guide [0] for
the following StarlingX staging repos:
- stx-python-cinderclient
- stx-nova
- stx-glance
- stx-neutron
Changes:
- [1] How to document your OpenStack API service
- Adding SPDX-License-Identifier: Apache-2.0
[0] https://docs.openstack.org/doc-contrib-guide
[1] https://docs.openstack.org/doc-contrib-guide/api-guides.html
Story: 2002712
Task: 26728
Change-Id: Ie8a142360b7c57d7ec477559757aa8295feb09ff
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
[dtroyer: fixed linters job and added to gate queue so this can be merged]
Story: 2002813
Task: 22727
Change-Id: I8a988cc49440b21176dc95bd12ad383836148dca
Signed-off-by: Erich Cordoba <erich.cordoba.malibran@intel.com>
Ron Stone