Browse Source

Change keystone-specs webpage from oslosphinx to openstackdocstheme

Change-Id: Iccdbee3ca64bc9c1ca6195d1725dd61a29ddcb20
Closes-Bug: #1755015
Nguyen Hai 1 year ago
parent
commit
9246e7e3d6
4 changed files with 16 additions and 23 deletions
  1. 4
    7
      doc/source/conf.py
  2. 10
    12
      doc/source/index.rst
  3. 1
    2
      requirements.txt
  4. 1
    2
      tox.ini

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

@@ -11,6 +11,7 @@
11 11
 
12 12
 import datetime
13 13
 import subprocess
14
+import warnings
14 15
 
15 16
 # If extensions (or modules to document with autodoc) are in another directory,
16 17
 # add these directories to sys.path here. If the directory is relative to the
@@ -24,21 +25,17 @@ import subprocess
24 25
 
25 26
 # Add any Sphinx extension module names here, as strings. They can be extensions
26 27
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28
+
27 29
 extensions = ['sphinx.ext.autodoc',
28 30
               'sphinx.ext.viewcode',
29 31
               'sphinxcontrib.blockdiag',
30
-              'oslosphinx',
31
-              'yasfb',
32
+              'openstackdocstheme',
32 33
              ]
33 34
 
34 35
 blockdiag_html_image_format = 'SVG'
35 36
 
36 37
 blockdiag_fontpath = 'DejaVuSans.ttf'
37 38
 
38
-# Feed configuration for yasfb
39
-feed_base_url = 'http://specs.openstack.org/openstack/keystone-specs'
40
-feed_author = 'OpenStack Identity Team'
41
-
42 39
 todo_include_todos = True
43 40
 
44 41
 # Add any paths that contain templates here, relative to this directory.
@@ -97,7 +94,7 @@ modindex_common_prefix = ['identity-specs.']
97 94
 
98 95
 # The theme to use for HTML and HTML Help pages.  See the documentation for
99 96
 # a list of builtin themes.
100
-html_theme = 'nature'
97
+html_theme = 'openstackdocs'
101 98
 
102 99
 # Theme options are theme-specific and customize the look and feel of a theme
103 100
 # further.  For a list of options available for each theme, see the

+ 10
- 12
doc/source/index.rst View File

@@ -1,8 +1,8 @@
1 1
 .. identity-specs documentation master file
2 2
 
3
-================================
3
+===============================
4 4
 Identity Program Specifications
5
-================================
5
+===============================
6 6
 
7 7
 Project Documentation:
8 8
 
@@ -12,7 +12,7 @@ Project Documentation:
12 12
    Specification Template <specs/template>
13 13
 
14 14
 keystone
15
-========
15
+--------
16 16
 
17 17
 Queens approved specs:
18 18
 
@@ -50,7 +50,7 @@ Ideas:
50 50
    specs/keystone/ideas/*
51 51
 
52 52
 keystoneauth
53
-============
53
+------------
54 54
 
55 55
 keystoneauth approved specs for the Newton release:
56 56
 
@@ -65,7 +65,7 @@ keystoneauth approved specs for the Newton release:
65 65
       specs/keystoneauth/newton/*
66 66
 
67 67
 keystoneclient
68
-==============
68
+--------------
69 69
 
70 70
 keystoneclient approved specs for the Newton release:
71 71
 
@@ -80,7 +80,7 @@ keystoneclient approved specs for the Newton release:
80 80
       specs/keystoneclient/newton/*
81 81
 
82 82
 keystonemiddleware
83
-==================
83
+------------------
84 84
 
85 85
 keystonemiddleware approved specs for the Newton release:
86 86
 
@@ -102,12 +102,11 @@ Backlog:
102 102
 
103 103
    specs/keystonemiddleware/backlog/*
104 104
 
105
-===========================================
106 105
 Implemented Identity Program Specifications
107 106
 ===========================================
108 107
 
109 108
 keystone
110
-========
109
+--------
111 110
 
112 111
 Pike approved specs:
113 112
 
@@ -166,7 +165,7 @@ Juno implemented specs:
166 165
    specs/keystone/juno/*
167 166
 
168 167
 keystoneauth
169
-============
168
+------------
170 169
 
171 170
 - None
172 171
 
@@ -179,7 +178,7 @@ keystoneauth
179 178
       specs/keystoneauth/mitaka/*
180 179
 
181 180
 keystoneclient
182
-==============
181
+--------------
183 182
 
184 183
 Mitaka implemented specs:
185 184
 
@@ -198,7 +197,7 @@ Liberty implemented specs:
198 197
    specs/keystoneclient/liberty/*
199 198
 
200 199
 keystonemiddleware
201
-==================
200
+------------------
202 201
 
203 202
 Kilo implemented specs:
204 203
 
@@ -216,7 +215,6 @@ Juno implemented specs:
216 215
 
217 216
   specs/keystonemiddleware/juno/*
218 217
 
219
-==================
220 218
 Indices and tables
221 219
 ==================
222 220
 

+ 1
- 2
requirements.txt View File

@@ -1,11 +1,10 @@
1 1
 # The order of packages is significant, because pip processes them in the order
2 2
 # of appearance. Changing the order has an impact on the overall integration
3 3
 # process, which may cause wedges in the gate later.
4
-oslosphinx>=2.2.0.0a2
5 4
 pbr>=2.0.0
6 5
 sphinx!=1.6.1,>=1.5.1
7 6
 sphinxcontrib-blockdiag
7
+openstackdocstheme>=1.17.0 # Apache-2.0
8 8
 testrepository>=0.0.18
9 9
 testtools>=0.9.34
10
-yasfb>=0.5.1
11 10
 doc8

+ 1
- 2
tox.ini View File

@@ -16,5 +16,4 @@ commands =
16 16
 commands = {posargs}
17 17
 
18 18
 [testenv:docs]
19
-basepython=python2.7
20
-commands = python setup.py build_sphinx
19
+commands = sphinx-build -W -b html doc/source doc/build/html

Loading…
Cancel
Save