From 208405289efbc604dd0acbb965c1835d240c84a3 Mon Sep 17 00:00:00 2001 From: Adrian Vladu Date: Fri, 15 Nov 2019 17:02:55 +0200 Subject: [PATCH] docs: change theme to sphinx_rtd_theme 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 --- doc/source/conf.py | 5 +++-- doc/source/intro.rst | 2 -- doc/source/plugins.rst | 5 ++--- doc/source/services.rst | 15 +++++++-------- doc/source/tutorial.rst | 2 -- doc/source/userdata.rst | 2 -- tox.ini | 2 ++ 7 files changed, 14 insertions(+), 19 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 80bd7381..c8ea6e8d 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -34,7 +34,8 @@ from cloudbaseinit import version as cbs_version extensions = [ 'sphinx.ext.autodoc', '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 # 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 # further. For a list of options available for each theme, see the diff --git a/doc/source/intro.rst b/doc/source/intro.rst index 2e26f98d..91d7bc31 100644 --- a/doc/source/intro.rst +++ b/doc/source/intro.rst @@ -1,5 +1,3 @@ -.. _intro: - Intro ===== diff --git a/doc/source/plugins.rst b/doc/source/plugins.rst index 67f7401b..c7f22e89 100644 --- a/doc/source/plugins.rst +++ b/doc/source/plugins.rst @@ -1,5 +1,3 @@ -.. _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). 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 -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 clear text password, coming from the metadata. The last option is "no", when the user is never forced. diff --git a/doc/source/services.rst b/doc/source/services.rst index 41d94407..437acd07 100644 --- a/doc/source/services.rst +++ b/doc/source/services.rst @@ -1,5 +1,3 @@ -.. _services: - Services ======== @@ -118,8 +116,8 @@ Config options: .. note:: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html -CloudStack ----------- +Apache CloudStack +----------------- .. class:: cloudbaseinit.metadata.services.cloudstack.CloudStack @@ -145,8 +143,8 @@ Config options: server. -OpenNebula ----------- +OpenNebula Service +------------------ .. class:: cloudbaseinit.metadata.services.opennebulaservice.OpenNebulaService @@ -180,8 +178,9 @@ Capabilities: * authentication certificates (x509) * user data -OVF ---- + +Open Virtualization Format (OVF) +-------------------------------- .. class:: cloudbaseinit.metadata.services.ovfservice.OvfService diff --git a/doc/source/tutorial.rst b/doc/source/tutorial.rst index a36a9eca..ec9be210 100644 --- a/doc/source/tutorial.rst +++ b/doc/source/tutorial.rst @@ -1,5 +1,3 @@ -.. _tutorial: - Tutorial ======== diff --git a/doc/source/userdata.rst b/doc/source/userdata.rst index 9f2605d2..efdbe87f 100644 --- a/doc/source/userdata.rst +++ b/doc/source/userdata.rst @@ -1,5 +1,3 @@ -.. _userdata: - Userdata ======== diff --git a/tox.ini b/tox.ini index 497fbf17..18a6eea7 100644 --- a/tox.ini +++ b/tox.ini @@ -38,6 +38,8 @@ commands = [testenv:docs] basepython = python3 +deps = + sphinx_rtd_theme commands = sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html