Ian Y. Choi
4d42034432
This commit proposes PDF generation with pdflatex.
Executing Sphinx with latex option generates .tex files will
be performed first, and pdflatex converts from .tex to .pdf files.
More details are as followings:
- Adds texlive related package binary dependency (>= Trusty)
: inkscape texlive-latex-base texlive-latex-extra
texlive-fonts-recommended
- build-rst.sh: --pdf option is added
- install-guide PDF support using --pdf option
- PDF support for serveral documents
: arch-design, cli-reference, ha-guide, ops-guide, user-guide,
networking-guide, arch-design-draft
(testable using like "tox -e build -- networking-guide --pdf")
- Intermidiate files for building .tex (required for converting into
.pdf) are stored in "build/pdf" folder.
Change-Id: I66242f44bb13f1a09be0904a491c84f42f25c3a2
Implements: blueprint build-pdf-from-rst-guides
Team and repository tags
OpenStack Manuals
This repository contains documentation for the OpenStack project.
For more details, see the OpenStack Documentation Contributor Guide.
It includes these manuals:
- Administrator Guide
- Architecture Design Guide
- Command-Line Interface Reference
- Configuration Reference
- Documentation Contributor Guide
- End User Guide
- High Availability Guide
- Installation Tutorials
- Networking Guide
- Operations Guide
- Virtual Machine Image Guide
In addition to the guides, this repository contains:
- docs.openstack.org contents:
www
Building
Various manuals are in subdirectories of the doc/
directory.
Guides
All guides are in the RST format. You can use tox to
prepare virtual environment and build all guides:
$ tox -e docsYou can also build a specific guide.
For example, to build OpenStack End User Guide, use the following command:
$ tox -e build -- user-guideYou can find the root of the generated HTML documentation at:
doc/user-guide/build/html/index.htmlTesting of changes and building of the manual
Install the Python tox package and run tox from the
top-level directory to use the same tests that are done as part of our
Jenkins gating jobs.
If you like to run individual tests, run:
tox -e checkbuild- to actually build the manualtox -e checklang- to build translated manualstox -e checkniceness- to run the niceness teststox -e linkcheck- to run the tests for working remote URLs
tox will use the openstack-doc-tools package for execution of these tests.
Contributing
Our community welcomes all people interested in open source cloud computing, and encourages you to join the OpenStack Foundation.
The best way to get involved with the community is to talk with
others online or at a meet up and offer contributions through our
processes, the OpenStack wiki,
blogs, or on IRC at #openstack on
irc.freenode.net.
We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.
If you would like to contribute to the documents, please see the OpenStack Documentation Contributor Guide.
Generated files
Some documentation files are generated using tools. These files
include a do not edit header and should not be modified by
hand. Please see Generated
files.
Bugs
Bugs should be filed on Launchpad, not GitHub:
Installing
Refer to http://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.