diff options
| author | Kaifeng Wang <kaifeng.w@gmail.com> | 2019-06-18 11:09:03 +0800 |
|---|---|---|
| committer | Kaifeng Wang <kaifeng.w@gmail.com> | 2019-09-05 18:43:33 +0800 |
| commit | 2e25b23539b882ad10074242e924208d65d95b97 (patch) | |
| tree | 67df545f643abd9c56268e004f00be4e543f16db /doc/source/conf.py | |
| parent | bbaa4599d926b8593e8752f77d1b36a9257de82b (diff) | |
| download | python-ironicclient-3.0.0.tar.gz | |
Build pdf doc3.0.0
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: I60e1e1b02ced34a7236fca4552ecf2f983cdb9d4
Diffstat (limited to 'doc/source/conf.py')
| -rw-r--r-- | doc/source/conf.py | 13 |
1 files changed, 5 insertions, 8 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 61e9a99..0893ad4 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -19,8 +19,7 @@ apidoc_separate_modules = True # openstackdocstheme options repository_name = 'openstack/python-ironicclient' -bug_project = 'python-ironicclient' -bug_tag = '' +use_storyboard = True # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. @@ -36,7 +35,6 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'python-ironicclient' copyright = u'OpenStack Foundation' # A list of ignored prefixes for module index sorting. @@ -66,11 +64,10 @@ exclude_patterns = ['api/ironicclient.tests.functional.*'] #html_static_path = ['_static'] html_theme = 'openstackdocs' -html_last_updated_fmt = '%Y-%m-%d %H:%M' - # Output file base name for HTML help builder. -htmlhelp_basename = '%sdoc' % project +htmlhelp_basename = 'python-ironicclientdoc' +latex_use_xindy = False # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass @@ -78,8 +75,8 @@ htmlhelp_basename = '%sdoc' % project latex_documents = [ ( 'index', - '%s.tex' % project, - u'%s Documentation' % project, + 'doc-python-ironicclient.tex', + u'Python Ironic Client Documentation', u'OpenStack LLC', 'manual' ), |