Browse Source

switch from oslosphinx to openstackdocstheme

Change-Id: I0dd253f90dfa2c4e5afd8d5fae3657a64788f1cf
Akihiro Motoki 1 year ago
parent
commit
b77c77f03e
3 changed files with 18 additions and 5 deletions
  1. 9
    1
      doc/source/conf.py
  2. 8
    3
      releasenotes/source/conf.py
  3. 1
    1
      test-requirements.txt

+ 9
- 1
doc/source/conf.py View File

@@ -25,9 +25,14 @@ extensions = [
25 25
     'sphinx.ext.autodoc',
26 26
     'sphinx.ext.viewcode',
27 27
     'sphinx.ext.doctest',
28
-    'oslosphinx',
28
+    'openstackdocstheme',
29 29
 ]
30 30
 
31
+# openstackdocstheme options
32
+repository_name = 'openstack/debtcollector'
33
+bug_project = 'debtcollector'
34
+bug_tag = 'doc'
35
+
31 36
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
32 37
 # text edit cycles.
33 38
 # execute "export SPHINX_DEBUG=1" in your terminal to disable
@@ -58,8 +63,11 @@ pygments_style = 'sphinx'
58 63
 # Sphinx are currently 'default' and 'sphinxdoc'.
59 64
 # html_theme_path = ["."]
60 65
 # html_theme = '_theme'
66
+html_theme = 'openstackdocs'
61 67
 # html_static_path = ['static']
62 68
 
69
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
70
+
63 71
 # Output file base name for HTML help builder.
64 72
 htmlhelp_basename = '%sdoc' % project
65 73
 

+ 8
- 3
releasenotes/source/conf.py View File

@@ -35,10 +35,15 @@
35 35
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
36 36
 # ones.
37 37
 extensions = [
38
-    'oslosphinx',
38
+    'openstackdocstheme',
39 39
     'reno.sphinxext',
40 40
 ]
41 41
 
42
+# openstackdocstheme options
43
+repository_name = 'openstack/debtcollector'
44
+bug_project = 'debtcollector'
45
+bug_tag = 'doc'
46
+
42 47
 # Add any paths that contain templates here, relative to this directory.
43 48
 templates_path = ['_templates']
44 49
 
@@ -109,7 +114,7 @@ pygments_style = 'sphinx'
109 114
 
110 115
 # The theme to use for HTML and HTML Help pages.  See the documentation for
111 116
 # a list of builtin themes.
112
-html_theme = 'default'
117
+html_theme = 'openstackdocs'
113 118
 
114 119
 # Theme options are theme-specific and customize the look and feel of a theme
115 120
 # further.  For a list of options available for each theme, see the
@@ -147,7 +152,7 @@ html_static_path = ['_static']
147 152
 
148 153
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
149 154
 # using the given strftime format.
150
-# html_last_updated_fmt = '%b %d, %Y'
155
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
151 156
 
152 157
 # If true, SmartyPants will be used to convert quotes and dashes to
153 158
 # typographically correct entities.

+ 1
- 1
test-requirements.txt View File

@@ -7,7 +7,7 @@ hacking<0.11,>=0.10.0
7 7
 coverage!=4.4,>=4.0 # Apache-2.0
8 8
 python-subunit>=0.0.18 # Apache-2.0/BSD
9 9
 sphinx>=1.6.2 # BSD
10
-oslosphinx>=4.7.0 # Apache-2.0
10
+openstackdocstheme>=1.11.0 # Apache-2.0
11 11
 testrepository>=0.0.18 # Apache-2.0/BSD
12 12
 testtools>=1.4.0 # MIT
13 13
 fixtures>=3.0.0 # Apache-2.0/BSD

Loading…
Cancel
Save