Commit Graph

6 Commits

Author SHA1 Message Date
Andreas Jaeger 21b755c2dc Update docs building
Switch to newer sphinx, update build instructions for it.

Remove oslosphinx, we use the default sphinx theme since oslosphinx does
not work with python3 and openstackdocstheme is only for OpenStack
projects.

Mark python 3.6 as latest python version.

Change-Id: I6aae0277d9e4943cc242e4ec868c949a14618ec7
2019-05-30 17:51:53 +02:00
Ian Wienand 16fef44f00 Autobuild of dashboard overview plus various fixes
This adds a call in sphinx to automatically generate the dashboard
description pages.  It's a little bit of a hack, but works with "tox
-e docs" and the readthedocs build.  This means we don't have to have
an external job running a separate build of the dashboard overview
page.

A couple of other things to integrate this and make the docs more
usable; we use the readme as the main page, fix up the links, use
sections in the template and add a clickable link to the dashboard in
each overview page.

I'ved tested this with readthedocs which you can see at [1]

[1] http://gerrit-dash-creator-dashboards.readthedocs.org/en/latest/

Change-Id: I027a21a40a0e35817b8a29996a48393743b282b0
2016-03-22 14:08:45 +11:00
Christian Berendt 76bbe6ea65 Adds 2015 copyright year to the Sphinx documentation
Change-Id: I10d4c1be2851b407a56493f5c85b2979b09eacdb
2015-01-07 13:32:50 +01:00
Christian Berendt ef286643f0 Add a script to generate a Sphinx dashboard documentation
Change-Id: I2bab3eed446b5d5350ca3ea1a5df559fcc2e48aa
2014-11-04 08:59:05 +01:00
Christian Berendt b4f66f9e2f Remove commented configuration of the intersphinx module
The intersphinx module should not be used. Remove commented configuration
of the intersphinx module to not enable it in the future.

Change-Id: Ie24b1c2842cf3bc2e82e094de905da7ac9d432a4
Related-Bug: #1368910
2014-09-23 22:30:01 +02:00
Christian Berendt 548aac7d25 Improve documentation
Improve the documentation based on the cookiecutter template.

Change-Id: I8ca35e2d7a3379d96b37acf4dd879e4ecec33d61
2014-08-08 06:01:05 +00:00