Switch to openstackdocstheme 2.2.1 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: I628af06b3702925bef790b3b3d1c47c2d7c7cbb0
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Remove obsolete sections from setup.cfg
- Update classifiers
- Use newer openstackdocstheme and Sphinx versions
- Cleanup */source/conf.py to remove now obsolete content.
- Remove install_command from tox.ini, the default is fine
Change-Id: Ib70fcdc751a1e84d3160558361a76bbd328f4625
This commit adds PDF documentation build target 'pdf-docs' that will
build PDF versions of our docs. And this commit also updates 'docs'
target to use sphinx-build command as well as 'pdf-docs' target.
This is one of the Train community goals:
https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html
Change-Id: Iae6bc9ae92fe61385c424923eaad35dc449880e9
Story: #2006070
Task: #35455
This commit separates the requirements libraries for the docs job in
tox.ini. The latest sphinx doesn't work in Python2 environments anymore.
So, we need to split that into the test and docs jobs.
Change-Id: I7255cd9af0dfb5c1f66c1aa65d0ddfb144079836
This commit introduces doc8 package to sanity the documents. As a
result, one minor doc8 violations were found and fixed.
Change-Id: I0e9d6212536e59e438a14f632c4fc6016c31cc60
This commit fixes the deprecated warning about 'use_html_smartypants'
config. We actually don't need to use it because when we quote command
line options, the conversion doesn't happen. So, this commit just
removes the config, and quotes the '--database-connection' option.
Change-Id: Ib1470e5f6febd08a9757a8773076faf3e9cd0eab
As part of the docs migration work[0] for Pike we need to switch to use the
openstackdocstheme.
[0] https://review.openstack.org/#/c/472275
Change-Id: I8a18f997aa1216fe8094265b8c0586c42d97b5ec
This commit disables the smartypants option of the document. We don't
need to convert quotes and dashes. And this commit also quotes the
--database-connection option. This should be better for the command
option description.
Change-Id: I79d3294eedf16085fa8c84d0ba203024cf80c181
This commit updates the docs theme to the new one. The new theme is the
standard of the openstack document. There is no reason to avoid to use
it.
Change-Id: If17ce35bd2ba50c3e1ae6e1567dcbe4be59d5189
This commit just updates years of copyright. This project is started
from 2016 not 2013, and this is still continuing. So I just updated it.
Change-Id: I86c7ac14782d9e0e4775026363cfab2fdfbe7bca