diff options
| author | Matthew Treinish <mtreinish@kortar.org> | 2015-07-07 18:32:59 -0400 |
|---|---|---|
| committer | Matthew Treinish <mtreinish@kortar.org> | 2015-07-14 16:13:47 -0400 |
| commit | 62575dd40e5b7698d9ba54641558246489f0614e (patch) | |
| tree | e4171b69127936baa62e63a7961d95bec8c0f21e /HACKING.rst | |
| parent | 42d91ebee0a2b162d9711be5e8b5a04486d63a63 (diff) | |
| download | nova-62575dd40e5b7698d9ba54641558246489f0614e.tar.gz | |
Add tool to build a doc latex pdf
The sphinx latex generation generates invalid latex that won't compile
when you try to use it.[1][2] This commit adds a helper script to generate
the sphinx latex and then modify it so it'll work. It depends on
ImageMagick convert and sed being available to work.
[1] https://github.com/sphinx-doc/sphinx/issues/1907
[2] https://github.com/sphinx-doc/sphinx/issues/1959
Change-Id: Id289c10907aaddae2483f18b39063852ec699d66
Diffstat (limited to 'HACKING.rst')
| -rw-r--r-- | HACKING.rst | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/HACKING.rst b/HACKING.rst index 42a0a4581d..d745a30753 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -103,16 +103,18 @@ which will cause a virtualenv with all of the needed dependencies to be created and then inside of the virtualenv, the docs will be created and put into doc/build/html. -If you'd like a PDF of the documentation, you'll need LaTeX installed, and -additionally some fonts. On Ubuntu systems, you can get what you need with:: +Building a PDF of the Documentation +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +If you'd like a PDF of the documentation, you'll need LaTeX and ImageMagick +installed, and additionally some fonts. On Ubuntu systems, you can get what you +need with:: - apt-get install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended + apt-get install texlive-full imagemagick -Then run ``build_sphinx_latex``, change to the build dir and run ``make``. -Like so:: +Then you can then use the ``build_latex_pdf.sh`` script in toos/ to take care +of both the the sphinx latex generation and the latex compilation. For example:: - tox -evenv -- python setup.py build_sphinx_latex - cd build/sphinx/latex - make + tools/build_latex_pdf.sh -You should wind up with a PDF - Nova.pdf. +The script must be run from the root of the Nova repository and it'll copy the +output pdf to Nova.pdf in that directory. |