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: 35466
Change-Id: Iefa8795ba985f502f952001cdc616dae20847ef9
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: Iabe6f531dcae728331698e7c70ad81adb86315cf
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Remove obsolete sections from setup.cfg
- Update classifiers
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Remove install_command from tox.ini, the default is fine
Change-Id: Ied0e774f0efda76794ecfb0f67a5fd51bb380258
Sphinx 2.0 no longer works on python 2.7,
so we need to start capping it there as well
depend on https://review.opendev.org/#/c/657890/
Change-Id: I4759dd3a5a9154978c874786b27aa17a37c3057f
This commit makes the doc use the openstack theme, and also adds
build-openstack-docs-pti job to ensure the tox job.
Change-Id: Iffa590d8325285094cd1d0bef9c5850616c9dedc
Because sphinx and oslosphinx module is not for the unit test.
I remove sphinx and oslosphinx from test-requirements.txt.
Add doc/requirements.txt and modify doc/source/_static/conf.py
Beacause of the build of py27 is failed(Zuul), I write this patch.
Change-Id: I306795ca0192675d8ffb9bbc2f1fa04165a45209
This document summarizes the required subunit2SQL usage to produce
run metadata, and additional arguments this program uses in code to
display data on test results.
Change-Id: Ieb1b3bf4cc63ad73b210db0275fde284277900a4
html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.
Change-Id: If616a209af5cafd600514e0dcb206df847eee80d
This commit fixes docs warnings when building docs. The installation and
usage documents are in README. So we don't need the entry in index.rst.
And _static directory is needed because it is declared in conf.py.
Change-Id: Ia34c2332a1099c5e181e9f27f472aae05c698431
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.
Change-Id: I409af47bb09cd5ba48e0e32a424b35d1f61323e9
Closes-Bug: #1529836
At this point the pages which we originally mocked up have all been
implemented. They served as a useful reference when we were first
bootstrapping the project, but we've grown beyond them now. This
also removes the last remaining bits of the license quagmire we
had with using highcharts since it is no longer in the code base
at all.
Change-Id: Icc3173b959ec0417f5ecd3804cf10d7d41ebfbe4
This commit removes the mockups, sample data files, and other js files
related to the mockups which served as guides to getting things up. We
already have working code landed for the first 2 pages and the mockups
don't really reflect what things actually look like any more. So there
really isn't a reason to keep them around anymore. We should also
remember to remove the mockups on the patches which implement the
corresponding page for real.
Change-Id: Ice14238928bcb534d9870ad51eb9585490bfd705
The small graphs for failures and runtime for each job of a project
looks better if we use sparkline based graphs, a sample is
provided by highcharts http://www.highcharts.com/demo/sparkline and
I based this work on that.
Change-Id: I52d3445d5fc7984e1fe6235de11280da812ba056
Co-Author: Dhiana Deva <ddeva@thoughtworks.com>
This commit adss the basic framework for unit tests of the rest api
and 2, yes 2, unit tests to cover the /runs and /tests endpoints.
This will be expanded in the future, but this is to just give us a
starting point as we expand the api.
Additionally, to unblock the repo this adds missing tox envs which
are needed to pass the docs job. It also takes care of the other
missing pieces to pass a build sphinx run.
Change-Id: Id46476285612789e3b7817eacc45125cf6c3a548
Tool tip shows value as temperature in Celcius, which isn't right.
Also break out json data as separate file to line up with all the
other commits.
Change-Id: I6561e2f7cb1f3a808430eafc860662e66896a48a
Signed-off-by: Ryan Moats <rmoats@us.ibm.com>
In addition, broke out data json as separate file for folks to work
with.
Change-Id: Iacb90241f76d0c8e1865fe765aa1af33809bd556
Signed-off-by: Ryan Moats <rmoats@us.ibm.com>