Package list python-castellan / 6a90cdc
PDF Documentation Build tox target This patch adds a `pdf-docs` tox target that will build PDF versions of our docs. As per the Train community goal: https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html Add sphinxcontrib-svg2pdfconverter to doc/requirements.txt to convert our SVGs. This PR also introduces the docs testenv and a doc requirements.txt file. Change-Id: If782737efe7114422be9cc3fc586500a2065f07e Story: 2006072 Alexandra Settle authored 2 years ago Andreas Jaeger committed 2 years ago
6 changed file(s) with 42 addition(s) and 15 deletion(s). Raw diff Collapse all Expand all
0 sphinx>=1.8.0,<2.0.0;python_version=='2.7' # BSD
1 sphinx>=1.8.0,!=2.1.0;python_version>='3.4' # BSD
2 sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
3 reno>=2.5.0 # Apache-2.0
4 openstackdocstheme>=1.18.1 # Apache-2.0
2222 'sphinx.ext.autodoc',
2323 #'sphinx.ext.intersphinx',
2424 'openstackdocstheme',
25 'sphinxcontrib.rsvgconverter',
2526 ]
2627
2728 # autodoc generation is a bit aggressive and a nuisance when doing heavy
7071 # Grouping the document tree into LaTeX files. List of tuples
7172 # (source start file, target name, title, author, documentclass
7273 # [howto/manual]).
74
7375 latex_documents = [
7476 ('index',
75 '%s.tex' % project,
77 'doc-castellan.tex',
7678 u'%s Documentation' % project,
7779 u'OpenStack Foundation', 'manual'),
7880 ]
81
82 latex_elements = {
83 'extraclassoptions': 'openany,oneside',
84 }
85
86 latex_use_xindy = False
7987
8088 # Example configuration for intersphinx: refer to the Python standard library.
8189 #intersphinx_mapping = {'https://docs.python.org/3/': None}
1414 user/index
1515 contributor/index
1616
17 Indices and tables
18 ==================
17 .. only:: html
1918
20 * :ref:`genindex`
21 * :ref:`modindex`
22 * :ref:`search`
19 Indices and tables
20 ==================
2321
22 * :ref:`genindex`
23 * :ref:`modindex`
24 * :ref:`search`
3030 msgpack-python==0.4.0
3131 netaddr==0.7.18
3232 netifaces==0.10.4
33 openstackdocstheme==1.18.1
3433 os-client-config==1.28.0
3534 oslo.config==6.4.0
3635 oslo.context==2.19.2
5554 python-subunit==1.0.0
5655 pytz==2013.6
5756 PyYAML==3.12
58 reno==2.5.0
5957 requests==2.14.2
6058 requestsexceptions==1.2.0
6159 rfc3986==0.3.1
6260 six==1.10.0
6361 smmap==0.9.0
6462 snowballstemmer==1.2.1
65 Sphinx==1.6.2
66 sphinxcontrib-websupport==1.0.1
6763 stevedore==1.20.0
6864 stestr==2.0.0
6965 testscenarios==0.4
55 coverage!=4.4,>=4.0 # Apache-2.0
66 python-barbicanclient>=4.5.2 # Apache-2.0
77 python-subunit>=1.0.0 # Apache-2.0/BSD
8 sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
9 sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD
10 openstackdocstheme>=1.18.1 # Apache-2.0
118 oslotest>=3.2.0 # Apache-2.0
129 stestr>=2.0.0 # Apache-2.0
1310 fixtures>=3.0.0 # Apache-2.0/BSD
1411 testscenarios>=0.4 # Apache-2.0/BSD
1512 testtools>=2.2.0 # MIT
1613 bandit>=1.1.0,<1.6.0 # Apache-2.0
17 reno>=2.5.0 # Apache-2.0
1814 pifpaf>=0.10.0 # Apache-2.0
5656 coverage report
5757
5858 [testenv:docs]
59 # This environment is called from CI scripts to test and publish
60 # the main docs to https://docs.openstack.org/castellan
61 description = Build main documentation
5962 basepython = python3
60 commands = python setup.py build_sphinx
63 deps = -r{toxinidir}/doc/requirements.txt
64 commands=
65 rm -rf doc/build doc/build/doctrees
66 sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html
67 whitelist_externals = rm
68
69 [testenv:pdf-docs]
70 basepython = python3
71 deps = {[testenv:docs]deps}
72 envdir = {toxworkdir}/docs
73 whitelist_externals =
74 rm
75 make
76 commands =
77 rm -rf doc/build/pdf
78 sphinx-build -W -b latex doc/source doc/build/pdf
79 make -C doc/build/pdf
6180
6281 [testenv:releasenotes]
6382 basepython = python3
83 deps = {[testenv:docs]deps}
84 envdir = {toxworkdir}/docs
6485 commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
6586
6687 [testenv:functional]