Merge "Update content to using Latex from rst2pdf"
This commit is contained in:
commit
55415f1c27
|
@ -41,11 +41,15 @@ Proposed change
|
||||||
Add the support of building PDFs using current Sphinx build
|
Add the support of building PDFs using current Sphinx build
|
||||||
infrastructure using RST-sourced files in openstack-manuals repository.
|
infrastructure using RST-sourced files in openstack-manuals repository.
|
||||||
|
|
||||||
After Sphinx build supports PDF file generation, apply PDF buildings to
|
Generating PDF files using RST-sourced files includes two steps in workflow.
|
||||||
all the HTML documents in openstack-manuals repository, add the build
|
First, Sphinx generates LaTeX files (.tex) from RST-sourced files.
|
||||||
job to work with HTML builds, publish PDF files on docs.openstack.org
|
Second, pdflatex generates PDF files from generated LaTeX files.
|
||||||
per each document build, and finally insert PDF download URLs
|
|
||||||
in the landing page of HTML documents.
|
After the combination of Sphinx and LaTeX supports PDF file generation,
|
||||||
|
apply PDF buildings to all the HTML documents in openstack-manuals repository
|
||||||
|
using LaTeX PDF generation. And add the build job to work with HTML builds,
|
||||||
|
publish PDF files on docs.openstack.org per each document build,
|
||||||
|
and finally insert PDF download URLs in the landing page of HTML documents.
|
||||||
|
|
||||||
Note that the main change will happen in openstack-doc-tools
|
Note that the main change will happen in openstack-doc-tools
|
||||||
for scripts, openstackdocstheme for possible additional themes for PDFs,
|
for scripts, openstackdocstheme for possible additional themes for PDFs,
|
||||||
|
@ -70,6 +74,7 @@ Assignee(s)
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
* ianychoi
|
* ianychoi
|
||||||
|
* nexusz99
|
||||||
* jangpro2
|
* jangpro2
|
||||||
* raymon-ha
|
* raymon-ha
|
||||||
* seungkyua
|
* seungkyua
|
||||||
|
@ -78,7 +83,7 @@ Assignee(s)
|
||||||
Work Items
|
Work Items
|
||||||
----------
|
----------
|
||||||
|
|
||||||
* Identifying requirements of libraries including rst2pdf
|
* Identifying requirements of libraries
|
||||||
* Checking the compatibility of the libraries
|
* Checking the compatibility of the libraries
|
||||||
* Changes in Sphinx configuration
|
* Changes in Sphinx configuration
|
||||||
* A basic PDF theme (fancy theme design is not the main goal)
|
* A basic PDF theme (fancy theme design is not the main goal)
|
||||||
|
@ -119,8 +124,7 @@ Project Scope
|
||||||
Dependencies
|
Dependencies
|
||||||
============
|
============
|
||||||
|
|
||||||
* Can be dependent on pdf build program (e.g., rst2pdf) version
|
* Can be dependent on pdf build program (e.g., LaTeX)
|
||||||
which is compatible with current Sphinx version for HTML builds
|
|
||||||
|
|
||||||
Testing
|
Testing
|
||||||
=======
|
=======
|
||||||
|
@ -135,4 +139,4 @@ References
|
||||||
|
|
||||||
* http://lists.openstack.org/pipermail/openstack-docs/2016-July/008867.html
|
* http://lists.openstack.org/pipermail/openstack-docs/2016-July/008867.html
|
||||||
* http://lists.openstack.org/pipermail/openstack-docs/2016-July/008869.html
|
* http://lists.openstack.org/pipermail/openstack-docs/2016-July/008869.html
|
||||||
* rst2pdf: https://pypi.python.org/pypi/rst2pdf
|
* https://review.openstack.org/#/c/396943/
|
||||||
|
|
Loading…
Reference in New Issue