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.
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: I467bf0ecbe308cfc39aed6aedd58f5947d2fc3df
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
know about the requirement
- Remove obsolete sections from setup.cfg
- Update classifiers
- Update requirements, no need for python_version anymore
- Switch to using sphinx-build
- Use newer openstackdocstheme and Sphinx versions
- Cleanup */source/conf.py to remove now obsolete content.
Change-Id: Icab2b68608002968bbc56791faedd119db7516e7
It's sad but as we still don't have any maintainers for this project,
I think it's time to start process of deprecating this as part of
the Neutron stadium.
Change-Id: I04221332f373aa6587c6bca151776fce3260517f
The document is simple enough, so 'howto' is specified as
documentclass instead of 'manual' as most projects do.
Change-Id: Ic6d9e893afc9853fe054756eba34767677510cfe
Story: 2006099
Task: 35130
Pep8 job is broken due to recent pep8 upgrade and corresponding
pycodestyle update.
This commit fixes the following errors:
- E402 module level import not at top of file
Change-Id: I0e6c31c6e8edd6994854f98d898ee897c91dd140
Currently we have a symlink to releasenotes directory in doc/source,
but this confuses the infra translation script and as a result
Zanata (translation platform) has two 'releasenotes' resources
for neutron-fwaas-dashboard. We can use a direct URL in toctree,
so this commit changes the URL of releasenotes in the toctree
to avoid confusing the infra translation script.
It also simplifies the document index page. Previously we have
same strings for title and toctree. This is meaningless.
If we have more contents in future, let's revisit the structure
of the top page.
Change-Id: Id348322bbc0bb134d7e6da1d2f91ec9a1c4ddfe7
Currently Firewall panel is located before "Security Groups" and
"Floating IPs". Considering the relationship between SG/FIP and
Networks/Routers, the current position of "Firewall" panel is
a bit confusing.
Change-Id: I4c04e9561cee8779c692921dfaf27212b87641b0
Closes-Bug: #1711785
Also updates URLs affected by the doc-migration work and
use https instead of http for docs.openstack.org contents.
Change-Id: I0fac335eb2ee46576ecdee2d50e17b1766d95860
In openstackdocstheme 0.11.0, the way to configure openstackdocstheme
was changed and the new way is really simple. Let's use it.
Change-Id: I94e5e0af47f5d9bf2321a6d93c18ce29848bb900
niuke