Commit Graph

16 Commits

Author SHA1 Message Date
Michael Johnson beb79ac98c Replace blockdiag with graphviz
The python blockdiag module is unmaintained and will likely be removed from distros.[1]
This patch replaces blockdiag with graphviz diagrams.

[1] https://github.com/blockdiag/blockdiag/pull/171

Change-Id: I3a902c60b59071b466e1bf1ec6bda205e58b378c
2023-07-28 20:00:07 +00:00
Andreas Jaeger 663e420643 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Set openstackdocs_auto_name to use 'project' 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.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

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.

Add openstackdocstheme options to api-ref.

Change-Id: I0cf71327ca5d9da1d88a826225374c8801849c36
2020-05-20 08:13:38 +02:00
Andreas Jaeger 21f94dea86 Cleanup docs building
* Switch to newer openstackdocstheme version and remove settings
  that are default now

Change-Id: Iec8791077aa7f1cb8edfa64235fb718a98aaba90
2020-02-23 17:33:27 +01:00
Ghanshyam Mann cdac0fc2f9 [ussuri][goal] Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

Designate is ready with python 3 and ok to drop the
python 2.7 support.

Complete discussion & schedule can be found in
- http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html
- https://etherpad.openstack.org/p/drop-python2-support

Ussuri Communtiy-wide goal:
https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

Depends-On: https://review.opendev.org/#/c/693631/
Change-Id: I5a5bdc859f87f82097b95b2ebb31edb6e9b72b3a
2019-12-13 18:49:14 +00:00
pengyuesheng 7ea9255539 Blacklist sphinx 2.1.0 (autodoc bug)
See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details

Change-Id: Iddb4a46ab1c22e84212932342b80c19194adcf3e
2019-08-01 17:22:01 +08:00
Adam Harwell af51a84477 Cap to sphinx 2.0.0 on Python 2.7
Sphinx 2.0.0 dropped Python 2.7 support. This is aligned with
Change-Id If558f184c959e4b63b56dec3ca1571d1034cfe5c in requirements
project.

Change-Id: I01467293fffbcf45ee9b311731f5d8699040215a
Co-Authored-By: Carlos Goncalves <cgoncalves@redhat.com>
2019-05-14 16:10:18 -07:00
OpenStack Proposal Bot 7a2adab56a Updated from global requirements
Change-Id: I9ffc7367b696a1f2eb63954d0d865a645869fa9a
2018-03-28 03:25:55 +00:00
melissaml 794dea3817 Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html

For more detials information, please refer to:
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Change-Id: Ic7dad29922af2efed2188f3215f364719f0e19ae
2018-03-27 10:30:57 +08:00
Graham Hayes 26d6298b97 Remove unneeded requirements file
Need to make requirements-check non-voting in order for this to pass,
will undo that afterwards.

Change-Id: Ibc77ea864503e63f73be0f1c41e07bfe8ea3dcae
2017-12-07 14:12:04 +00:00
Kiall Mac Innes df59ced756 Read the Docs needs a single requirements file
Change-Id: I27c8bbcffc6022872b826738592193233b00cea4
2014-03-28 13:41:06 +00:00
Kiall Mac Innes a314b8e34e Standardize doc requirements
We now match the other projects

Change-Id: I6d8a82843b20dbebcb0d5105d7e6e2c7b5093b2a
2014-03-04 21:33:33 +00:00
Kiall Mac Innes 42299f4eb1 Sync doc/requirements.txt with openstack/requirements
Change-Id: I89bd363bb9b7455c06d0e09cf6a61b515f7d1f30
2013-08-16 13:39:37 +01:00
Kiall Mac Innes e29a2b8370 Ensure sphinx and sphinxcontrib-httpdomain are installed for doc builds
Change-Id: I1be2865a5d9809c030decaa71c415ca14228116b
2013-07-09 05:43:57 +01:00
Kiall Mac Innes e8a8a3c981 Ensure RTD builds install all the necessary deps
doc/requirements.txt now proxies to the main requirement files

Change-Id: I8b5d0323bb478bdf5db67f13db30313fe7c67344
2013-07-09 05:35:44 +01:00
Kiall Mac Innes 07203697ea Minor doc cleanup's
Change-Id: I159fcf8059c576833c5101cc473ffde9c4a9a575
2013-01-18 12:19:52 +00:00
Endre Karlson 749f730f4a Add requirements for RTD
Change-Id: Ibe91a36210e30d8816f61b0238b8ca59a2c0d2c4
2012-11-01 10:48:41 +01:00