Commit Graph

8 Commits

Author SHA1 Message Date
Lukas Piwowarski f46106c2f5 Create tox environment to build pdf documentation
This patch enables building .pdf documentation using new 'pdf-docs'
tox environment. The newly created tox environment creates latex
source codes using sphinx-build and then builds the pdf
documentation using make.

Story: 2006070
Task: 35467

Change-Id: Ie2b3df9f09445ca4f71bb1fbf69c92a4d7b3e719
2020-09-24 10:48:20 +02:00
Andreas Jaeger 57582a48bb Switch to newer openstackdocstheme version
Switch to openstackdocstheme 2.2.1 version. Using
this version will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Disable openstackdocs_auto_name to use 'project' variable as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I6e9989f1882cf5729e644e240311c9b73bd578b6
2020-06-02 14:19:07 +02:00
Ghanshyam Mann 1031cab577 [ussuri][goal] Update contributor documentation
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html
Story: #2007236
Task: #38554

Change-Id: I5106dca0f379a9ced19ea209de460980d407345f
2020-04-22 14:04:58 +00:00
Andreas Jaeger 3d06be24dc Fix docs building
In preparation for python 3 support switch to newer sphinx version.
This requires openstackdocstheme.

Remove install_command, this is the default.
Update hacking version to be compatible with python 3, fix warnings
from new pep8.

Change-Id: Iab69ec59eb111571f784242c5ea5756c2a63e424
2020-02-03 22:13:58 +01:00
DeepaJon 260408ce16 Removes unnecessary utf-8 encoding
This patches removes unnecessary utf-8 encoding in the
doc/source/conf.py
os_performance_tools/__init__.py
os_performance_tools/tests/base.py
os_performance_tools/tests/test_collect.py
os_performance_tools/tests/test_collectors_delta.py
os_performance_tools/tests/test_counters2statsd.py
os_performance_tools/tests/test_mysql.py
os_performance_tools/tests/test_queues.py

Change-Id: Ifa32ae370cd29c270413989903d0eda3b2b8238a
2017-01-11 18:04:01 +05:30
Clint Byrum 9fa4ce73a2 Add documentation to each collector. 2015-11-24 00:07:32 -08:00
Clint Byrum 4099c44e21 Rename to os-performance-tools
The name was too generic, and would have become a problem for import
into OpenStack's QA program. So focus it on performance tools.
2015-11-09 15:16:51 -08:00
Clint Byrum 1e26e2206f Initial Cookiecutter Commit. 2015-10-15 14:09:34 -07:00