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.
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: I5db2dc63ea51f0005aa1244b5b9c692ec23ce314
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 ancient sections from setup.cfg
- Update requirements
- Remove unused import from conf.py
Change-Id: I87261d38992dedd87709ad8beff0bb533064e118
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.
Change-Id: I432ae5415b9ab8ca7247fb5fb2a8b6e1819029ba
This change adds a sphinx extention to build sections of the policy and
profile documentation from source code.
- Add new extension
- Modify contributor documentation for policies to show spec fields
from source code
- Modify user documentation for policies and profiles to show properties
from source code
- Modify user documentation for policies and profiles to include
samples extracted from examples directory
- Update tox to run pep8 against sphinx extension
Change-Id: I32f68867d14c3288385dbdf3b4df14e8ca2fd01f
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: Ia8551b45c1d7b4d67368e493e143c3893d07df61
This patch fixes several problems in the doc tree:
- The scaling and heat integration subsections should be removed
from
tutorial, which is meant to be a quick introduction to senlin
operations.
- Moved some overview text from the global index into a dedicated
subsection for the autoscaling section.
- Fixed some problems related to format code blocks.
- Fixed the git command problem in the conf file.
Change-Id: Ice538cf65deb241d745f6793200bf09342ae227d
There some pep8 errors outside the main code directory. These files are
examined each time we run 'flake8' and the problems therein will surface
in these occasions. This patch fixes such problems.
Change-Id: If19bbb4d5377549ad5ba5af438b35941ff1c81c0
We need to provide some detailed reference documentation for builtin
policies. These documentation can then be referenced from other
document.
Change-Id: Iba739a4dc0e0fd16fbcf2406aecb3053f0fde76d
This patch fixes two problems: 1) the graphviz package installation
should be a requirement so that the flowchart can be built; 2) the
indentation in action.rst is causing doctools to misunderstand its
grammar.
Change-Id: Ib7189316d890d9bc65f5344eba17e15ee52b8f62
os.popen() is deprecated since python 2.6. Resolved with use of
subprocess module.
Change-Id: Ifa5f6bbfabf2d5ebfdbee21920aa12c0a8e30517
Closes-Bug: #1529836
For docs set the launchpad project users report bugs
against to "senlin". Users can report bugs
using the "bug icon" that will
directly link to the launchpad project, it currently goes to
"openstack-manuals" which is wrong for this content.
This variable is used by openstackdocstheme 1.2.6.
Also, update comments for the variables passed to
openstackdocstheme.
Change-Id: I15d8cbc4e59b28351f21026f60b1131083540112
Related-Bug: #1524476
wangjiaqi07