6 Commits

Author SHA1 Message Date
Andreas Jaeger
e9854ff408 Switch to newer openstackdocstheme and reno versions
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.

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: I20ea481c1dd9651258b8ae13da9b1e1ec710482b
2020-05-25 09:43:04 +00:00
Kaifeng Wang
e3681c1390 Build pdf doc
The is one of community goals that each project could produce a
single PDF file. The pdf should be in the output of openstack-tox-docs
job.

TeX packages are required to build PDF locally, following is recommended:

* inkscape
* texlive-latex-base
* texlive-latex-extra
* texlive-fonts-recommended

More about the goal:
https://governance.openstack.org/tc/goals/train/pdf-doc-generation.html
https://etherpad.openstack.org/p/train-pdf-support-goal
https://etherpad.openstack.org/p/pdf-goal-train-common-problems

Change-Id: I5f2caba62595946f8ade6db22a1aba080b927fc8
2019-09-06 10:36:22 +08:00
Ilya Etingof
6d9c5ed424 Tolerate missing openstackdocstheme in docs
Change-Id: I658d08fdb0e9946a660b079571b406d935e34441
2018-09-20 23:04:09 +02:00
Arundhati Surpur
99a0277970 Removes unnecessary utf-8 encoding
This patches removes unnecessary utf-8
encoding in doc/source/conf.py

Change-Id: I6fe1610ae245e18deb94e80a9f12c41ea3d493b6
2017-07-20 15:42:03 +05:30
Ilya Etingof
93043f32a1 rearrange existing documentation to follow the new layout standard
Change-Id: I2ac8f8f78147a5f75a2394f240154ee4472a7879
2017-07-17 14:57:41 +02:00
Lucas Alvares Gomes
85a0b201ff Restructure the repository according to OpenStack
This patch is restructuring the VirtualBMC repository according to the
OpenStack template for projects (Cookiecutter).

This patch also removes the dependency on the python-daemon library
since it is not present in the OpenStack global-requirements, now a new
class called "detach_process" has been added to the virtualbmc/utils.py
module that will take care of detaching the process context from its
parent and session.

Change-Id: Id4ae1db5b73a18abc54276fe1dfbf3ceff7adc06
2016-05-09 12:35:50 +01:00