Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.
Set openstackdocs_auto_name to use 'project' as name.
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.
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.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I6430e16e22a2afc0fda3a5a43eccfd3309f20931
doc8 is a linter for documents and used in Docs team.
Let's enforce the linter for better writing of I18n contributor guide.
(The rules are the same in I3810df521068ffc97e25a5fc56b72397bf9783bc)
Change-Id: Ib7662e6ea8095b371074e6404dbb179e89a00a94
This commit update the document theme. :)
The bug link points to openstack-i18n launchpad project
so that readers can report a bug against openstack-i18n project.
Co-Authored-By: Akihiro Motoki <amotoki@gmail.com>
Change-Id: I5356b5d0ba19acc5f6eb86b6e67fd9e5151167da
translation_team.yaml is now used by stackalytics.
It is a good idea to YAML format check in pep8 check.
Change-Id: I33f6311412a5cb67692992e1ba021d56eede7ce5
The commit is generated by the following command
in requirements repository:
python update.py ../i18n
The automatic job is now under review in
https://review.openstack.org/256976
Change-Id: I1ff2a375c9b251a218e512687e2c77150634e7cf
This commit adds tox.ini and define test targets.
Naming of tox targets follows OpenStack most projects:
- docs for document generation
For mainly a testing purpose, contributor-guide/source/index.rst
includes CONTRIBUTING.rst at the top level.
To generate the current doc, run "tox -e docs".
setup.py and setup.cfg are added because they are
required to publish the docs to docs.o.o.
Co-Authored-By: Akihiro Motoki <amotoki@gmail.com>
Implements: blueprint i18n-contributor-guide
Change-Id: Iaf3b09865ced8b30f987b68a07c2970d2b425708
Andreas Jaeger