Commit Graph

8 Commits

Author SHA1 Message Date
Peter Matulis 289f61afc9 Up sphinx for Python 3.10 - Jammy
On Jammy hosts the docs will not build due to an
incompatibility between Sphinx and Python 3.10.
Increase Sphinx version in requirements.txt to at
least 4.2.

Change-Id: I34d9c1a6baa042535ea74758c9a4b51f97e6965a
2023-01-03 13:13:44 -05:00
Peter Matulis 8c9c623b76 Redirect links for config-openstack
Adds a redirect capabilities for the charm-deployment-guide for the
config-openstack.html to configure-openstack.html renaming. This also
adds whereto testing in order to validate and confirm that the redirect
links are working as intended.

Note, this will redirect the user from the config-openstack.html for any
of the release names. This may result in a 404 not found if an older
release is being accessed since the renaming/refactoring will not be
backported.

Co-Authored-By: Peter Matulis <peter.matulis@canonical.com>
Co-Authored-By: Billy Olsen <billy.olsen@canonical.com>

Change-Id: I61d2eabadd76c86fa63b49c6b7552bcb1ee20d67
2021-01-25 15:25:25 -07:00
Andreas Jaeger cb2f8a3e75 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.

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: I666adb3c053b914d81790c56e08fd2ce9f6a7d1a
2020-05-31 20:20:00 +02:00
Andreas Jaeger dedd32a684 Small cleanups
Remove obsolete sections from setup.cfg
Remove python2 lines from requirements, the repo uses only python3.

Change-Id: I919fca05fa031e7bb17f7800a8f3a16b482e0a04
2020-04-07 13:20:19 +02:00
Andreas Jaeger 4950df7899 Switch to current docs tools
Update repo to use current Sphinx and openstackdocstheme versions:
* update requirements
* update conf.py to correctly set variables
* update tox.ini to use python3

Change-Id: I44d41c3d78dfddf325ef7c65a8e1c9a1ddf96094
2019-10-25 09:16:39 +02:00
Andreas Jaeger 60069b0276 Fix links - and make them robust
There's no .md file in here, so change links. Looking at the used links,
these are all external links and thus sphinx cannot test whether they
work. Use internal links so that all links work - and work even after
renames.

This shows up as e.g.:
 WARNING: unknown document: install-maas.html

Update tox.ini so that these are hard errors.

Remove dead requirement oslosphinx, it's not needed anymore here since
openstackdocstheme is used.

Change-Id: Ieae398aecb48c2e26de5c50261e700f8790e64ce
2019-07-26 16:07:36 +02:00
Liam Young 3fdc6d33b3 Add instructions for upgrading OpenStack
This patch adds instructions for upgrading OpenStack using the
charms.

Depends-On: I03f3d641b50cfc6f02262edb0f714ba6e9566775
Change-Id: I9019da2c79c1262043714a1605efd85700478744
2018-02-19 11:29:23 +00:00
James Page 6f73e1681f Extra bits 2017-06-19 10:43:50 +01:00