6 Commits

Author SHA1 Message Date
Andreas Jaeger
1d5dfa2468 Update docs building
The repo used both openstackdocstheme and oslosphinx in requirements but
then configured openstackdocstheme, remove oslosphinx everywhere.

Instead of using sphinx-build, use  docstheme-build-translated.sh to
build English and translated documents.

Update doc/source/conf.py for newer openstackdocstheme and require
a new enough version.

Remove module index - it does not exist, this is not a python repo where
autodoc works.

Remove sphinx-quickstart generated output from index.rst, it's not
needed anymore.

Change-Id: Ib3f09128226f0bcc78384b1ee2da811d62a5b59d
2019-01-05 09:22:36 +00:00
Doug Hellmann
16df480a3c fix tox python3 overrides
We want to default to running all tox environments under python 3, so
set the basepython value in each environment.

We do not want to specify a minor version number, because we do not
want to have to update the file every time we upgrade python.

We do not want to set the override once in testenv, because that
breaks the more specific versions used in default environments like
py35 and py36.

Change-Id: I5b07c573ea3594c011adc0ffbe629f0229e611f0
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2018-10-01 06:46:25 +00:00
Tin Lam
c90cf794da Update doc build to use py3
Per Stein community goal [0], update the doc build to use python 3 by default.

[0] https://governance.openstack.org/tc/goals/stein/python3-first.html

Change-Id: I3992632a0768b4da0dedf2450e532d2724fc2e05
Signed-off-by: Tin Lam <tin@irrational.io>
2018-08-11 22:58:38 -05:00
Tin Lam
e6991e1914 Update docs building infra
This patch set migrates some of the file structure in compliance with
the Project Testing Interface (PTI) [0] for doc build in OpenStack-Infra.
See [1] for more details.

[0] https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation
[1] http://lists.openstack.org/pipermail/openstack-dev/2017-November/124815.html

Change-Id: I5995ffd3a6821fd629e00351728c27a045a7c076
Signed-off-by: Tin Lam <tin@irrational.io>
2017-12-29 00:07:26 -06:00
Gage Hugo
7b90c4017b Add upper constraints for testing
This change adds upper constraints for running tox in order
to both solve the issue with sphinx 1.6.1 and pbr breaking
the docs gate [0], as well as helping prevent this from
occuring in the future when a tool updates and ends up
causing issue with other required libraries.

This also adds an exclusion for 1.6.1 in test requirements
as posted here [1].

[0] https://bugs.launchpad.net/pbr/+bug/1691129
[1] http://lists.openstack.org/pipermail/openstack-dev/2017-May/116821.html

Change-Id: I025e75fed186236be51c0fcfb7d35f694b0e42d8
2017-05-16 13:34:42 -05:00
Michał Dulko
e795466247 Beggining of docs conversion to OpenStack format
This commit introduces initial infrastructure for building documentation
using the OpenStack's sphinx extension and tox. To demonstrate that
README.md is rewritten into README.rst and should appear in
documentation built by `tox -e docs`.

Partial-Implements: blueprint docs-to-rst

Change-Id: I08ebad1c572e248a8f474e785d3bf7a19dbc4340
2017-04-27 17:04:17 +02:00