It is now 2022 and the copyright date should reflect that.
Signed-off-by: Tin Lam <tin@irrational.io>
Change-Id: Id4871590680a95527c58b8e90d5cab7479a43257
Now that it is 2021, this patch updates the copyright date to reflect
the correct years.
Change-Id: I7ce07588d18a463dc256cb6ed87424fc55d4e2c7
Signed-off-by: Tin Lam <tin@irrational.io>
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: I46021aa93e28242d0f7dc9d80f598538247a6df5
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove obsolete sections from setup.cfg
- Update requirements, no need for python_version anymore
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Remove install_command from tox.ini, the default is fine
Change-Id: I785318b3090d7117d74d165ba3236dc239cf9ea1
The repo used both openstackdocstheme and oslosphinx in requirements but
then configured openstackdocstheme, remove oslosphinx everywhere.
Instead of using sphinx-build, use docstheme-build-translated.sh to
build English and translated documents.
Update doc/source/conf.py for newer openstackdocstheme and require
a new enough version.
Remove module index - it does not exist, this is not a python repo where
autodoc works.
Remove sphinx-quickstart generated output from index.rst, it's not
needed anymore.
Change-Id: Ib3f09128226f0bcc78384b1ee2da811d62a5b59d
Images are often powerful tool to communicate when making a doc.
This PS hopely adds sphinxcontrib-blockdig to documentation tool.
Please give me feedback if this is right way to add it.
Some examples are:
https://docs.openstack.org/infra/zuul/user/gating.html
Change-Id: I7e8d8322df4bcc651e43e28d68ea5128660c592c
Since OSH is an official project and the documentation is published
to docs.o.o, this patch set updates the conf.py to update the theme
to be inline with other openstack projects.
Change-Id: I8e4a8d9e1d2098ef074c3d9503c5c81297f513a7
This patch set addresses readthedocs.org loading oslosphinx, which results
in some inconsistencies. It should simply use the rtd theme on the rtd
environment.
Change-Id: I35f599416d3764a2ed0961653b3ce45717335e72
This commit introduces initial infrastructure for building documentation
using the OpenStack's sphinx extension and tox. To demonstrate that
README.md is rewritten into README.rst and should appear in
documentation built by `tox -e docs`.
Partial-Implements: blueprint docs-to-rst
Change-Id: I08ebad1c572e248a8f474e785d3bf7a19dbc4340
