Browse Source

Update docs theme

This commit updates the docs theme to the new one. The new theme is the
standard of the openstack document. There is no reason to avoid to use
it.

Change-Id: If17ce35bd2ba50c3e1ae6e1567dcbe4be59d5189
Masayuki Igawa 1 year ago
parent
commit
20f1fb6f10
No account linked to committer's email address
3 changed files with 8 additions and 6 deletions
  1. 4
    2
      doc/source/conf.py
  2. 3
    4
      doc/source/index.rst
  3. 1
    0
      test-requirements.txt

+ 4
- 2
doc/source/conf.py View File

@@ -15,6 +15,8 @@
15 15
 import os
16 16
 import sys
17 17
 
18
+import openstackdocstheme
19
+
18 20
 sys.path.insert(0, os.path.abspath('../..'))
19 21
 # -- General configuration ----------------------------------------------------
20 22
 
@@ -54,8 +56,8 @@ pygments_style = 'sphinx'
54 56
 
55 57
 # The theme to use for HTML and HTML Help pages.  Major themes that come with
56 58
 # Sphinx are currently 'default' and 'sphinxdoc'.
57
-# html_theme_path = ["."]
58
-# html_theme = '_theme'
59
+html_theme_path = [openstackdocstheme.get_html_theme_path()]
60
+html_theme = 'openstackdocs'
59 61
 # html_static_path = ['static']
60 62
 
61 63
 # Output file base name for HTML help builder.

+ 3
- 4
doc/source/index.rst View File

@@ -3,10 +3,12 @@
3 3
    You can adapt this file completely to your liking, but it should at least
4 4
    contain the root `toctree` directive.
5 5
 
6
+========================================================
6 7
 Welcome to coverage2sql's documentation!
7 8
 ========================================================
8 9
 
9
-Contents:
10
+Contents
11
+========
10 12
 
11 13
 .. toctree::
12 14
    :maxdepth: 2
@@ -19,7 +21,4 @@ Contents:
19 21
 Indices and tables
20 22
 ==================
21 23
 
22
-* :ref:`genindex`
23
-* :ref:`modindex`
24 24
 * :ref:`search`
25
-

+ 1
- 0
test-requirements.txt View File

@@ -19,3 +19,4 @@ os-testr>=0.8.0 # Apache-2.0
19 19
 reno>=1.8.0 # Apache-2.0
20 20
 oslo.concurrency>=3.8.0 # Apache-2.0
21 21
 six>=1.9.0 # MIT
22
+openstackdocstheme>=1.5.0 # Apache-2.0

Loading…
Cancel
Save