Commit Graph

7 Commits

Author SHA1 Message Date
Andreas Jaeger dca59921e2 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: I0b21a468b8952c6189764b8f17bb2ffc057aefec
2020-05-31 20:18:50 +02:00
Andreas Jaeger 77dfcdd291 Doc cleanup, use openstackdocstheme
Switch to "modern" way of docs building in OpenStack:
* Use sphinx-build
* Use openstackdocstheme instead of old oslosphinx
* Adjust settings for openstackdocstheme
* Fix build errors:
  - There's no priorities folder in this repo,
    so remove non-existing links.
  - There's no backlog file, remove link.
  - remove links in specs that don't exist
  - fix RST link formatting
  - Fix RST errors

Change-Id: I0d1d1c866957e7dbd5d4e394b0368a0a5250b00b
2020-02-23 14:53:22 +01:00
Frode Nordahl 434f5778d8
Fix lint
Add upper constraints for ``Sphinx`` requirement, changes in
upstream version 2.0.0 is breaking this repository.

Change-Id: I01eb10d747ba830c824428c5b32fba18a4f8470c
2019-04-24 08:38:09 +02:00
Ha Manh Dong 65fee4ceee Switch to use stestr for unit test
According to Openstack summit session [1],
stestr is maintained project to which all Openstack projects should migrate.
So we should switch to stestr.

[1] https://etherpad.openstack.org/p/YVR-python-pti

Change-Id: I4cd261ce5cc4ac7a26fb644eb43c2848f2c26f8b
2018-07-17 13:36:45 +07:00
Billy Olsen 776af925ca Sync requirements versions with global-requirements
There is a failure in building the docs due to old
versions of sphinx and oslosphinx.

This commit syncs those updates from global-requirements
to allow builds to succeed again.

Change-Id: I6605d4c4d9cb3420d2b5c9b23390d5dae3d00b00
2017-09-01 18:43:48 -07:00
xhzhf e1cf9deeb0 error occur when executing "tox -e docs"
error message link is below
http://paste.openstack.org/show/599515/
So change docutils version from 0.13.1 to other in order to solve it

Change-Id: I6ed143e29d11e1309cbfae20901efb849db87809
2017-02-18 18:50:39 +08:00
James Page 532486201d Base 2016-05-26 11:24:00 +01:00