diff options
author | Joshua Powers <josh.powers@canonical.com> | 2019-09-07 02:27:45 +0000 |
---|---|---|
committer | Server Team CI Bot <josh.powers+server-team-bot@canonical.com> | 2019-09-07 02:27:45 +0000 |
commit | 385232dc8da6532b54342cd11e6d822ff7cd3e5a (patch) | |
tree | ef0f51ecd8a348407cbea7662a3e55bc105e890d /doc/rtd/conf.py | |
parent | c7688981e1070c75f3c3f31e707e7be272dd43d6 (diff) | |
download | cloud-init-git-385232dc8da6532b54342cd11e6d822ff7cd3e5a.tar.gz |
doc: document doc, create makefile and tox target
* Create makefile and tox targets for documentation building and testing
to better replicate the live web docs using the same theme.
* Created docs.rst to explain how to build and contribute to documentation
with style guide and tips.
* doc/rtd/conf.py:
* Add copyright to rtd config
* Use Sphinx's RTD theme to replicate actual docs
Diffstat (limited to 'doc/rtd/conf.py')
-rw-r--r-- | doc/rtd/conf.py | 13 |
1 files changed, 3 insertions, 10 deletions
diff --git a/doc/rtd/conf.py b/doc/rtd/conf.py index 4174477c..9b274843 100644 --- a/doc/rtd/conf.py +++ b/doc/rtd/conf.py @@ -17,7 +17,8 @@ from cloudinit.config.schema import get_schema_doc # ] # General information about the project. -project = 'Cloud-Init' +project = 'cloud-init' +copyright = '2019, Canonical Ltd.' # -- General configuration ---------------------------------------------------- @@ -59,15 +60,7 @@ show_authors = False # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -html_theme_options = { - "bodyfont": "Ubuntu, Arial, sans-serif", - "headfont": "Ubuntu, Arial, sans-serif" -} +html_theme = 'sphinx_rtd_theme' # The name of an image file (relative to this directory) to place at the top # of the sidebar. |