Browse Source

switch to openstackdocstheme

Also fix warnings

Change-Id: I0ffd8140ec98233b54dacb045989c976e03db355
changes/88/481488/5
zhurong 1 year ago
parent
commit
9d558be065
4 changed files with 29 additions and 9 deletions
  1. 8
    4
      README.rst
  2. 10
    2
      doc/source/conf.py
  3. 10
    2
      releasenotes/source/conf.py
  4. 1
    1
      test-requirements.txt

+ 8
- 4
README.rst View File

@@ -15,22 +15,26 @@ Murano package validator tool
15 15
 
16 16
 After checking out tool from repository easiest method to run tool is to run
17 17
 
18
-.. code-block:: shell
18
+.. code-block:: console
19
+
19 20
   tox -e venv -- murano-pkg-check -h
20 21
 
21 22
 This command will display help for murano-pkg-validator
22 23
 
23 24
 If you installed it from PYPI you can use:
24
-.. code-block:: shell
25
+.. code-block:: console
26
+
25 27
   murano-pkg-check -h
26 28
 
27 29
 To run validator in directory apache-app just run:
28
-.. code-block:: shell
30
+.. code-block:: console
31
+
29 32
   murano-pkg-check apache-app
30 33
 
31 34
 It will print all errors there are on package.
32 35
 
33
-.. code-block:: shell
36
+.. code-block:: console
37
+
34 38
   murano-pkg-check --discovery murano-apps
35 39
 
36 40
 Will search for all packages under directory `murano-apps`. It will print all

+ 10
- 2
doc/source/conf.py View File

@@ -22,8 +22,7 @@ sys.path.insert(0, os.path.abspath('../..'))
22 22
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
23 23
 extensions = [
24 24
     'sphinx.ext.autodoc',
25
-    #'sphinx.ext.intersphinx',
26
-    'oslosphinx'
25
+    'openstackdocstheme'
27 26
 ]
28 27
 
29 28
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
@@ -57,6 +56,15 @@ pygments_style = 'sphinx'
57 56
 # html_theme_path = ["."]
58 57
 # html_theme = '_theme'
59 58
 # html_static_path = ['static']
59
+html_theme = 'openstackdocs'
60
+
61
+# openstackdocstheme options
62
+repository_name = 'openstack/murano-pkg-check'
63
+bug_project = 'murano-pkg-check'
64
+bug_tag = ''
65
+
66
+# Must set this variable to include year, month, day, hours, and minutes.
67
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
60 68
 
61 69
 # Output file base name for HTML help builder.
62 70
 htmlhelp_basename = '%sdoc' % project

+ 10
- 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,15 @@ 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
+
116
+# openstackdocstheme options
117
+repository_name = 'openstack/murano-pkg-check'
118
+bug_project = 'murano-pkg-check'
119
+bug_tag = ''
120
+
121
+# Must set this variable to include year, month, day, hours, and minutes.
122
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
115 123
 
116 124
 # Theme options are theme-specific and customize the look and feel of a theme
117 125
 # further.  For a list of options available for each theme, see the

+ 1
- 1
test-requirements.txt View File

@@ -7,7 +7,7 @@ hacking<0.12,>=0.11.0 # Apache-2.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
 oslotest>=1.10.0 # Apache-2.0
12 12
 testrepository>=0.0.18 # Apache-2.0/BSD
13 13
 testscenarios>=0.4 # Apache-2.0/BSD

Loading…
Cancel
Save