Browse Source

Revert "Switch from oslosphinx to openstackdocstheme"

openstackdocstheme is only for Official OpenStack projects, see
https://docs.openstack.org/openstackdocstheme/latest/

this repo is not an official project under governance.

This reverts commit 66d45fc53d.

Fix build problems:
* Fix wrong include path
* Disable sphinxmark

Change-Id: I83e91d12e82a8cf703f4b09c7d315edbb9878bd9
changes/91/479591/4
Andreas Jaeger 1 year ago
parent
commit
7aa600e42f
4 changed files with 9 additions and 22 deletions
  1. 4
    12
      doc/source/conf.py
  2. 2
    2
      doc/source/develop.rst
  3. 2
    7
      releasenotes/source/conf.py
  4. 1
    1
      test-requirements.txt

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

@@ -45,8 +45,9 @@ import pbr.version
45 45
 # ones.
46 46
 extensions = [
47 47
     'sphinx.ext.autodoc',
48
-    'openstackdocstheme',
49
-    'sphinxmark'
48
+    'oslosphinx',
49
+    # Disabled, does not build
50
+    # 'sphinxmark'
50 51
 ]
51 52
 
52 53
 # Add any paths that contain templates here, relative to this directory.
@@ -121,22 +122,13 @@ todo_include_todos = False
121 122
 # The theme to use for HTML and HTML Help pages.  See the documentation for
122 123
 # a list of builtin themes.
123 124
 #
124
-html_theme = 'openstackdocs'
125
+html_theme = 'default'
125 126
 
126 127
 # Theme options are theme-specific and customize the look and feel of a theme
127 128
 # further.  For a list of options available for each theme, see the
128 129
 # documentation.
129
-html_theme_options = {
130
-    "display_toc": False
131
-}
132 130
 
133 131
 # Add any paths that contain custom themes here, relative to this directory.
134
-# html_theme_path = ["."]
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'
140 132
 
141 133
 # -- Options for HTMLHelp output ------------------------------------------
142 134
 

+ 2
- 2
doc/source/develop.rst View File

@@ -23,9 +23,9 @@ Testing plugins
23 23
 ---------------
24 24
 
25 25
 Add tests in the ``tests`` directory and follow the ``uptime`` example. Here
26
-are the contents of ``tests/test_plugin_uptime.py`` as an example:
26
+are the contents of ``tests/int/test_plugin_uptime.py`` as an example:
27 27
 
28
-.. literalinclude:: ../../tests/test_plugin_uptime.py
28
+.. literalinclude:: ../../tests/int/test_plugin_uptime.py
29 29
 
30 30
 Running tests
31 31
 -------------

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

@@ -44,7 +44,7 @@ import pbr.version
44 44
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
45 45
 # ones.
46 46
 extensions = [
47
-    'openstackdocstheme',
47
+    'oslosphinx',
48 48
     'reno.sphinxext',
49 49
 ]
50 50
 
@@ -120,7 +120,7 @@ todo_include_todos = False
120 120
 # The theme to use for HTML and HTML Help pages.  See the documentation for
121 121
 # a list of builtin themes.
122 122
 #
123
-html_theme = 'openstackdocs'
123
+html_theme = 'default'
124 124
 
125 125
 # Theme options are theme-specific and customize the look and feel of a theme
126 126
 # further.  For a list of options available for each theme, see the
@@ -129,11 +129,6 @@ html_theme = 'openstackdocs'
129 129
 # html_theme_options = {}
130 130
 
131 131
 # Add any paths that contain custom themes here, relative to this directory.
132
-# html_theme_path = []
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'
137 132
 
138 133
 # -- Options for HTMLHelp output ------------------------------------------
139 134
 

+ 1
- 1
test-requirements.txt View File

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

Loading…
Cancel
Save