This commit changes working dir from which sphinx-build is
run when using tox to make it working in same way as it is
done on readthedocs.org when documentation is build.
This commit also fixes path to oslo-config-generator config file
that it will be fine for spinx-build to autogenerate config.
Change-Id: I14982b3cbaa0bc87390e8694c4c866a3b7c375fa
In Read The Docs service only one single requirements file is
supported for the project. See [1] for details.
So we need to have "rtd-requirements" file which will include all
requirements for the project.
[1] https://github.com/readthedocs/readthedocs.org/issues/1112
Change-Id: I6512558ae67d4a874135cdbf2bcb50d8a94ac7f5
This patch adds to "docs" tox job ability to automatically
generate sample config file and config reference based on
config options defined in code.
Change-Id: Id960cc28d1b13ef3ed15e911f59620afb83f45b9
* Setup proper logging
* Extend os-faults configuration template with more services
* Add unit tests initial files (Python API and CLI)
* Add proper doc explaining how to use tobiko faults
Change-Id: I6d528981fea6c76d20f4da095a86189748038f77
This also improve other documentation pages and add many
cross section references.
This guide has been tested on CentOS 7 (Python 2.7) and
RHEL8 (Python 3.6).
Change-Id: I827dcf7237792ab94286c960968df405c7e548b9
* Add a simple explanation of what Tobiko is to README.rst
* Instead of duplicating README.rst content in to doc/index.rst,
just pull the content from it via an rst directive.
Change-Id: I878bf9517fce54827bc5b4528bd1af695352f8cb
- Add docs CI job and Tox environment
- Create RST documentation sckeleton
- Use OpenStack theme for releasenotes job.
- Move docs/ code to doc/ folder to conform to OpenStack standards.
Change-Id: I8b917abe46125fec32076637a041a728257fa96a