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.
Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.
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: Ia039d70c66d05ee0ca64bb8e85920bc36d16831a
The previously choosen PDF file name conflicts in some repos with the
project logos (badge). Thus change https://review.opendev.org/679777
renames the desired PDF name to be doc-PROJECT.pdf to allow using the
badge in PDF files.
Follow this rename.
Change-Id: I5e3fd82455b121e99f85d050a31f399b0986a920
The document is simple enough, so 'howto' is specified as
documentclass instead of 'manual' as most projects do.
Change-Id: Iea024acb205b1045369367bdbf8e800793fedd2f
Story: 2006099
Task: 35136
1. Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7.
2. Remove unncessary "=="
Change-Id: Iac246b16befbaeabbc6e2f935a4443475d70e8ea
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: Ibb444748d8797631394c1f4ee6176363eb69eb05
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: I9340577e9d1dc684fcd845a2fd2720eecac625f6
Currently VPN panel is located before "Security Groups" and "Floating
IPs". Considering the relationship between SG/FIP and Networks/Routers,
the current position of "VPN" panel is a bit confusing.
Change-Id: I640accd20933da87ae5764e3c300b5305281dd4c
Closes-Bug: #1711785
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: I3f8775cc54ece19915ab7b06285a0e7d2995eb8b
* Adopt openstackdocstheme
* Document structure follows doc-migration spec
https://review.openstack.org/#/c/472275/
* Release notes is generated as part of doc build to make
doc publishing easy. neutron-vpnaas is not an official project
and cannot publish it to docs.o.o.
Change-Id: I4fb1058fc078b32d549db3c66d91c85e0bdbe7a5
Andreas Jaeger