x/cloudbase-init
Code Issues Proposed changes

docs: change theme to sphinx_rtd_theme

Browse Source 
Changed docs theme to a better, mobile friendly one:
https://github.com/readthedocs/sphinx_rtd_theme

The duplicate labels were removed, as the sphinx extension
sphinx.ext.autosectionlabel requires unique titles (labels).

Change-Id: Ife17206c3b2370250388692a9330585f5193e450
This commit is contained in:
Adrian Vladu 2019-11-15 17:02:55 +02:00
parent bb7d604532
commit 208405289e
7 changed files with 14 additions and 19 deletions

5
doc/source/conf.py

@ -34,7 +34,8 @@ from cloudbaseinit import version as cbs_version
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
'oslo_config.sphinxext' 'oslo_config.sphinxext',
'sphinx.ext.autosectionlabel',
] ]
@ -116,7 +117,7 @@ todo_include_todos = False
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
html_theme = 'classic' html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme # 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 # further. For a list of options available for each theme, see the

2
doc/source/intro.rst

@ -1,5 +1,3 @@
.. _intro:
Intro Intro
===== =====

5
doc/source/plugins.rst

@ -1,5 +1,3 @@
.. _plugins:
Plugins Plugins
======= =======
@ -69,7 +67,8 @@ password isn't found in metadata, then an attempt of using an already set
password is done (usually a random value by the `createuser` plugin). password is done (usually a random value by the `createuser` plugin).
With `first_logon_behaviour` you can control what happens with the password at With `first_logon_behaviour` you can control what happens with the password at
the next logon. If this option is set to "always", the user will be forced to the next logon. If this option is set to "always", the user will be forced to
change the password at the next logon. If it is set to "clear_text_injected_only", change the password at the next logon.
If it is set to "clear_text_injected_only",
the user will be forced to change the password only if the password is a the user will be forced to change the password only if the password is a
clear text password, coming from the metadata. The last option is "no", clear text password, coming from the metadata. The last option is "no",
when the user is never forced. when the user is never forced.

15
doc/source/services.rst

@ -1,5 +1,3 @@
.. _services:
Services Services
======== ========
@ -118,8 +116,8 @@ Config options:
.. note:: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html .. note:: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html
CloudStack Apache CloudStack
---------- -----------------
.. class:: cloudbaseinit.metadata.services.cloudstack.CloudStack .. class:: cloudbaseinit.metadata.services.cloudstack.CloudStack
@ -145,8 +143,8 @@ Config options:
server. server.
OpenNebula OpenNebula Service
---------- ------------------
.. class:: cloudbaseinit.metadata.services.opennebulaservice.OpenNebulaService .. class:: cloudbaseinit.metadata.services.opennebulaservice.OpenNebulaService
@ -180,8 +178,9 @@ Capabilities:
* authentication certificates (x509) * authentication certificates (x509)
* user data * user data
OVF
--- Open Virtualization Format (OVF)
--------------------------------
.. class:: cloudbaseinit.metadata.services.ovfservice.OvfService .. class:: cloudbaseinit.metadata.services.ovfservice.OvfService

2
doc/source/tutorial.rst

@ -1,5 +1,3 @@
.. _tutorial:
Tutorial Tutorial
======== ========

2
doc/source/userdata.rst

@ -1,5 +1,3 @@
.. _userdata:
Userdata Userdata
======== ========

2
tox.ini

@ -38,6 +38,8 @@ commands =
[testenv:docs] [testenv:docs]
basepython = python3 basepython = python3
deps =
sphinx_rtd_theme
commands = commands =
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html