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: Iedbe8c96c57403d5ee7208cc89bddd9809b70eb2
Moe the installation and contributor "guides" under 'install' and
'contributor', respectively, and remove some noise from the root index.
Change-Id: I96ef285dfa6624ca8bee79f2ec508eb2f9ff25b1
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
- Don't remove badges - simply exclude them from the main docs.
- Don't include stuff that only makes sense in HTML - namely the indexes
- Don't explicitly set basepython in a tox testenv when we can inherit
it
Change-Id: Ib3db3888d0bb1c47773e3e44919c7077d0906ceb
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
This follows the instructions [1] in an attempt to build pdf docs.
To get a build, the "badge" in the README has been removed.
The other option to add some svg -> pdf support, but that seems
overkill for a badge which is effectively meaningless.
The build wanted 'xindy' to build an index, but we can turn that
off and still get useful results.
[1] https://etherpad.openstack.org/p/train-pdf-support-goal
Change-Id: Icf7c22bf9d1de6fb2a74a756c370930d4c00b0b9
Story: 2006110
Task: 35397
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.
Note that redirects will be set up as well but let's point now to the
new location.
For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html
Change-Id: Ib9e2658f123e1d4a12261f54cf91415c2c339dda
The latter does not work well with Sphinx 2.0.
Switching brings us up to date with modern norms. The
changes made here are to get it working:
* Changing tox jobs to the modern style, with a separate
requirements.txt in the doc directory.
* Updating doc and releasenotes conf.py to use the new
theme and correctly point at storyboard for bugs
* Remove docs related requirements from test-requirements.txt
Change-Id: I9770f375b0fd7a6cacdd02e3d0381a28879f18b5
This adds the initial usage docs and a release note for the
first set of commands available in what will be the 1.0.0
release for the osc-placement plugin in the Queens series.
There are some other changes to the docs layout:
* The cliff.sphinxext is used to get the CLI reference.
* The README is inlined to the top docs index page.
* The usage doc is changed to the user/index.rst format
based on the docs.o.o manuals migration spec.
* The ordering of the contents is also changed based on
the docs.o.o manuals migration spec.
* The modindex is removed since it doesn't exist and since
there are no python API bindings in this library, we don't
need a module index anyway.
Depends-On: Id18aab2a95849bc60769f2f81c363c17d049b21f
Part of blueprint placement-osc-plugin
Change-Id: I552688b9ee32b719a576a7a9ed5e4d5aa31d7b3f
