Browse Source

Update docs building

* Use openstackdocstheme instead of obsolete oslosphinx
* Update requirements to current versions
* Use sphinx-build instead of pbr specific commands
* Fix wrong indend to avoid sphinx warning

Change-Id: I5aff91ec45466f25b825b1729561976db69eb188
changes/55/599755/3
Andreas Jaeger 8 months ago
parent
commit
c112ea2053
4 changed files with 14 additions and 8 deletions
  1. 3
    3
      bindep/depends.py
  2. 7
    1
      doc/source/conf.py
  3. 3
    3
      test-requirements.txt
  4. 1
    1
      tox.ini

+ 3
- 3
bindep/depends.py View File

@@ -234,10 +234,10 @@ class Depends(object):
234 234
 
235 235
         :param rules: A list of rules, as returned by active_rules.
236 236
         :param output_format: The format to print the output in. Currently
237
-        we support newline format which will print 1 package per line, and
238
-        csv format which prints a csv list.
237
+          we support newline format which will print 1 package per line, and
238
+          csv format which prints a csv list.
239 239
         :return: List of all required packages regardless of whether they are
240
-        missing.
240
+          missing.
241 241
         """
242 242
         packages_list = [rule[0] for rule in rules]
243 243
         if output_format == 'csv':

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

@@ -24,9 +24,15 @@ sys.path.insert(0, os.path.abspath('../..'))
24 24
 extensions = [
25 25
     'sphinx.ext.autodoc',
26 26
     'sphinxcontrib.programoutput',
27
-    'oslosphinx'
27
+    'openstackdocstheme'
28 28
 ]
29 29
 
30
+# Setting for openstackdocstheme
31
+html_theme = 'openstackdocs'
32
+repository_name = 'openstack-infra/bindep'
33
+bug_tag = ''
34
+use_storyboard = True
35
+
30 36
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
31 37
 # text edit cycles.
32 38
 # execute "export SPHINX_DEBUG=1" in your terminal to disable

+ 3
- 3
test-requirements.txt View File

@@ -4,8 +4,8 @@ coverage>=3.6
4 4
 fixtures>=0.3.12
5 5
 mock>=2.0  # BSD
6 6
 python-subunit
7
-sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
8
-oslosphinx>=2.5.0
9
-sphinxcontrib-programoutput
10 7
 testrepository>=0.0.13
11 8
 testtools>=0.9.27
9
+sphinx>1.6.1  # BSD
10
+openstackdocstheme>=1.24.1  # Apache-2.0
11
+sphinxcontrib-programoutput  # BSD license

+ 1
- 1
tox.ini View File

@@ -20,7 +20,7 @@ commands = {posargs}
20 20
 commands = python setup.py test --coverage --testr-args='{posargs}'
21 21
 
22 22
 [testenv:docs]
23
-commands = python setup.py build_sphinx
23
+commands = sphinx-build -W -b html doc/source doc/build/html
24 24
 
25 25
 [flake8]
26 26
 # E123, E125 skipped as they are invalid PEP-8.

Loading…
Cancel
Save