Browse Source

Switch from oslosphinx to openstackdocstheme

As part of the docs migration work[0] for Pike we need to switch to use
the openstackdocstheme.

[0]https://review.openstack.org/#/c/472275/

Change-Id: I7c001fa8f627dc991759e157a802588962af53d9
Van Hung Pham 1 year ago
parent
commit
66d45fc53d
3 changed files with 12 additions and 10 deletions
  1. 6
    4
      doc/source/conf.py
  2. 5
    4
      releasenotes/source/conf.py
  3. 1
    2
      test-requirements.txt

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

@@ -23,8 +23,6 @@
23 23
 """Docs config for monitorstck."""
24 24
 import os
25 25
 
26
-import openstackdocstheme
27
-
28 26
 import pbr.version
29 27
 
30 28
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -47,7 +45,7 @@ import pbr.version
47 45
 # ones.
48 46
 extensions = [
49 47
     'sphinx.ext.autodoc',
50
-    'oslosphinx',
48
+    'openstackdocstheme',
51 49
     'sphinxmark'
52 50
 ]
53 51
 
@@ -133,8 +131,12 @@ html_theme_options = {
133 131
 }
134 132
 
135 133
 # Add any paths that contain custom themes here, relative to this directory.
136
-html_theme_path = [openstackdocstheme.get_html_theme_path()]
134
+# html_theme_path = ["."]
137 135
 
136
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
137
+# using the given strftime format.
138
+# html_last_updated_fmt = '%b %d, %Y'
139
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
138 140
 
139 141
 # -- Options for HTMLHelp output ------------------------------------------
140 142
 

+ 5
- 4
releasenotes/source/conf.py View File

@@ -23,8 +23,6 @@
23 23
 """Release notes for monitorstack."""
24 24
 import os
25 25
 
26
-import openstackdocstheme
27
-
28 26
 import pbr.version
29 27
 
30 28
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -46,7 +44,7 @@ import pbr.version
46 44
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
47 45
 # ones.
48 46
 extensions = [
49
-    'oslosphinx',
47
+    'openstackdocstheme',
50 48
     'reno.sphinxext',
51 49
 ]
52 50
 
@@ -131,8 +129,11 @@ html_theme = 'openstackdocs'
131 129
 # html_theme_options = {}
132 130
 
133 131
 # Add any paths that contain custom themes here, relative to this directory.
134
-html_theme_path = [openstackdocstheme.get_html_theme_path()]
132
+# html_theme_path = []
135 133
 
134
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
135
+# using the given strftime format.
136
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
136 137
 
137 138
 # -- Options for HTMLHelp output ------------------------------------------
138 139
 

+ 1
- 2
test-requirements.txt View File

@@ -8,8 +8,7 @@ flake8-import-order==0.11 # LGPLv3
8 8
 mock>=2.0  # BSD
9 9
 
10 10
 # this is required for the docs build jobs
11
-sphinx>=1.5.1 # BSD
12
-oslosphinx>=4.7.0 # Apache-2.0
11
+sphinx>=1.6.2 # BSD
13 12
 openstackdocstheme>=1.5.0 # Apache-2.0
14 13
 doc8 # Apache-2.0
15 14
 reno>=1.8.0 # Apache-2.0

Loading…
Cancel
Save