Browse Source

Merge "Use openstackdocstheme for docs and release notes"

Zuul 1 year ago
parent
commit
28dd13b94d
3 changed files with 16 additions and 5 deletions
  1. 7
    1
      doc/source/conf.py
  2. 7
    2
      releasenotes/source/conf.py
  3. 2
    2
      test-requirements.txt

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

@@ -23,7 +23,7 @@ sys.path.insert(0, os.path.abspath('../..'))
23 23
 extensions = [
24 24
     'sphinx.ext.autodoc',
25 25
     #'sphinx.ext.intersphinx',
26
-    'oslosphinx'
26
+    'openstackdocstheme'
27 27
 ]
28 28
 
29 29
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
@@ -57,6 +57,7 @@ pygments_style = 'sphinx'
57 57
 # html_theme_path = ["."]
58 58
 # html_theme = '_theme'
59 59
 # html_static_path = ['static']
60
+html_theme = 'openstackdocs'
60 61
 
61 62
 # Output file base name for HTML help builder.
62 63
 htmlhelp_basename = '%sdoc' % project
@@ -73,3 +74,8 @@ latex_documents = [
73 74
 
74 75
 # Example configuration for intersphinx: refer to the Python standard library.
75 76
 #intersphinx_mapping = {'http://docs.python.org/': None}
77
+
78
+# openstackdocstheme options
79
+repository_name = 'openstack/cursive'
80
+bug_project = 'cursive'
81
+bug_tag = 'docs'

+ 7
- 2
releasenotes/source/conf.py View File

@@ -38,7 +38,7 @@
38 38
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
39 39
 # ones.
40 40
 extensions = [
41
-    'oslosphinx',
41
+    'openstackdocstheme',
42 42
     'reno.sphinxext',
43 43
 ]
44 44
 
@@ -111,7 +111,7 @@ pygments_style = 'sphinx'
111 111
 
112 112
 # The theme to use for HTML and HTML Help pages.  See the documentation for
113 113
 # a list of builtin themes.
114
-html_theme = 'default'
114
+html_theme = 'openstackdocs'
115 115
 
116 116
 # Theme options are theme-specific and customize the look and feel of a theme
117 117
 # further.  For a list of options available for each theme, see the
@@ -274,3 +274,8 @@ texinfo_documents = [
274 274
 
275 275
 # -- Options for Internationalization output ------------------------------
276 276
 locale_dirs = ['locale/']
277
+
278
+# openstackdocstheme options
279
+repository_name = 'openstack/cursive'
280
+bug_project = 'cursive'
281
+bug_tag = 'docs'

+ 2
- 2
test-requirements.txt View File

@@ -7,8 +7,8 @@ hacking<0.12,>=0.11.0 # Apache-2.0
7 7
 coverage>=3.6 # Apache-2.0
8 8
 python-subunit>=0.0.18 # Apache-2.0/BSD
9 9
 mock>=2.0.0 # BSD
10
-sphinx!=1.3b1,<1.3,>=1.2.1 # BSD
11
-oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0
10
+sphinx>=1.6.2,!=1.6.6 # BSD
11
+openstackdocstheme>=1.17.0  # Apache-2.0
12 12
 oslotest>=1.10.0 # Apache-2.0
13 13
 testrepository>=0.0.18 # Apache-2.0/BSD
14 14
 testscenarios>=0.4 # Apache-2.0/BSD

Loading…
Cancel
Save