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.
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: I6c6775f75235dab2b9ed7820bfc5102bf5b04965
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.
Change-Id: Ibc5757b36d6a5b8c342d959087136064ed5ab6f5
Ussuri Communtiy-wide goal:
https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html
Include small cleanups:
* remove install_command from tox.ini, this is the default
* Use sphinx-build as modern way to run sphinx, remove setup.cfg
settings for build-sphinx
* Use sphinxcontrib-apidoc for docs with newer sphinx
* Remove obsolete doc/source/conf.py broken
* Add python-requires to setup.cfg to make Python 3.6 requirement
explicit
* Remove obsolete pbr setup-hooks
Co-Authored-By: Andreas Jaeger <aj@suse.com>
Change-Id: Iec8c47b82022b616b8361651bf23f853b0ce5624
A temporary fix was added to get around a bug in how pbr handles
its autodoc_tree_index_modules setting. Since this bug is fixed we no
longer need the work around.
This change is needed since the workaround is now incompatible with the
latest version of Sphinx.
See also[1][2].
[1] https://review.opendev.org/191633
[2] https://review.opendev.org/121667
Change-Id: Idf9dc73d99b4233f49effe24aa047959b1a2ef2c
Following the new doc migration spec, the documentation
theme needs to be switched to openstackdocstheme.
Change-Id: Ia840524a4c3b4ceb9605c997a2971d84880c70ac
The doc-migration spec requires all projects to treat warnings
as errors during sphinx build. This patches turns that function
on and resolves the error (detailed below) coming as a result
of it.
The code block in event_concept.rst file is currently made to
render in javascript which is an incorrect syntax for it.
Change-Id: Id7fee247b76ed7cfebb849305e0611bc966709be
The migration spec has listed some changes in the URLs of project
directories. This commit fixes those changed URLs.
Change-Id: Id040fdf9cc16cd6b05c82cc93e88301f743a1801
The openstack.org pages now support https and our references to
the site should by default be one signed by the organization.
Change-Id: Ib2dce89ac43e844a5f1b3adcfe9bcaf4141043ce
There's no RST file that uses ".. math" and thus
the pngmath Sphinx extension is not used and can
get removed.
Change-Id: I3ea4b529025c8ac3c4092f3720124647861e6668
original design prepended a namespace to the beginning of uuid.
this scoped the uuid to a namespace but it is technically invalid.
this patch drops the behaviour of prepending string. rather, it
takes the namespace, hashes it, and uses uuid v5 to generate valid
uuid based on that namespace
Change-Id: Ibde222c91522fa3c4a1720b6a8da81dac31560b9
Closes-Bug: #1504889
The section was more of a `note` than an `example`, and renders
more clearly when the rst `note` tag is used.
Change-Id: I7b7c92301ce2bcfa60b44a0297eeb3848d89355e
- the end of the intro paragraph came to an unexpected stop, so clean
that up.
- suggest removing the debugging section, as that is now maintained
by oslotest:
http://docs.openstack.org/developer/oslotest/features.html
- add more info to the contributing section, since it was lacking
before.
Change-Id: I7abd5b0ce192f18fa80a208ac5b191d1c7bd2981
1) Added code-block headers to the JSON examples
2) Formatted the JSON examples
3) Replaced a few instances of double-byte characters with more
their usual counter parts ("-" and "'"), these normally originate
from the openstack wiki for some reason.
Change-Id: I2ca1dbfc5bdf1c50da466b290a6460a42f1b885a
- fix image width to conform to formatting
- move specification out of dev section
- redirect middleware doc to keystonemiddleware
- add full spec pdf link to specifications page
- drop tree depth so we don't have 'serialisation' subheaders in toc
Change-Id: Ia36c029b792f574b2b30623b3b2696242b79d75c
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)
This also removes the requirement for internet access during docs build.
This can cause docs jobs to fail if the project errors out on
warnings.
Change-Id: I6d0bb0678ff35a751c0b7c40cb73803701eb8a75
Related-Bug: #1368910
Running a test with pdb was difficult because tox captures
output and causes pdb prompt to quit.
Tips for how to run with debug are provided here:
https://wiki.openstack.org/wiki/Testr#Debugging_.28pdb.29_Tests
This change puts these commands into a debug env in tox.ini so
you can do a command like
tox -e debug pycadf.tests.test_cadf_spec
and when it hits your breakpoint you'll get the debug prompt.
Change-Id: I53893d618cd60c0456368088497542db7e4a6eac
Co-Authored-By: Brant Knudson <bknudson@us.ibm.com>
