Browse Source

Updated from global requirements

--

Bump the openstackdocstheme extension to 1.20

Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.

Ic9207bb8d3e602dd71cc4c7cefde739130f3d48b

--

Blacklist sphinx 2.1.0 (autodoc bug)

See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details

Ia029f66cfde96d97754e38b5278f1b24081a09e0

--

tox: Keeping going with docs

1. Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name
suggests, keeps the build running when it encounters non-fatal errors.
This is exceptionally useful in avoiding a continuous edit-build loop
when undertaking large doc reworks where multiple errors may be
introduced.

2. Remove the py27 from tox since magnum already drop support python 2.7

[1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045

I6e713b51cf9fac87e696fdfce8156f656a0f1df5

--

Change-Id: I53800a688fae3ba9cc551b0ceffe96938f2df59d
changes/13/536313/10
pengyuesheng 2 years ago
committed by Bharat Kunwar
parent
commit
599a7c392d
6 changed files with 10 additions and 23 deletions
  1. +0
    -1
      doc/source/conf.py
  2. +0
    -12
      releasenotes/source/conf.py
  3. +4
    -4
      requirements.txt
  4. +1
    -1
      setup.py
  5. +3
    -3
      test-requirements.txt
  6. +2
    -2
      tox.ini

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

@ -23,7 +23,6 @@ sys.path.insert(0, os.path.abspath('../..'))
extensions = [
'sphinx.ext.autodoc',
'openstackdocstheme',
#'sphinx.ext.intersphinx',
]
# autodoc generation is a bit aggressive and a nuisance when doing heavy


+ 0
- 12
releasenotes/source/conf.py View File

@ -52,7 +52,6 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'magnum_tempest_plugin Release Notes'
copyright = u'2017, OpenStack Developers'
# openstackdocstheme options
@ -196,17 +195,6 @@ htmlhelp_basename = 'magnum_tempest_pluginReleaseNotesdoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
# 'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).


+ 4
- 4
requirements.txt View File

@ -2,8 +2,8 @@
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
pbr>=2.0 # Apache-2.0
pbr!=2.1.0,>=2.0.0 # Apache-2.0
tempest>=17.1.0 # Apache-2.0
oslo.config>=3.22.0 # Apache-2.0
six>=1.9.0
oslo.log>=3.30.0 # Apache-2.0
oslo.config>=5.2.0 # Apache-2.0
six>=1.10.0 # MIT
oslo.log>=3.36.0 # Apache-2.0

+ 1
- 1
setup.py View File

@ -25,5 +25,5 @@ except ImportError:
pass
setuptools.setup(
setup_requires=['pbr'],
setup_requires=['pbr>=2.0.0'],
pbr=True)

+ 3
- 3
test-requirements.txt View File

@ -4,8 +4,8 @@
hacking>=1.1.0,<1.2.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
openstackdocstheme>=1.11.0 # Apache-2.0
sphinx>=1.8.0,!=2.1.0 # BSD
openstackdocstheme>=1.20.0 # Apache-2.0
# releasenotes
reno>=1.8.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
stestr>=2.0.0 # Apache-2.0

+ 2
- 2
tox.ini View File

@ -1,6 +1,6 @@
[tox]
minversion = 3.1.1
envlist = py36,py34,py27,pypy,pep8
envlist = py36,py34,pypy,pep8
skipsdist = True
ignore_basepython_conflict = True
@ -37,7 +37,7 @@ commands = python setup.py build_sphinx
[testenv:releasenotes]
commands =
sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
sphinx-build -a -E -W -d releasenotes/build/doctrees --keep-going -b html releasenotes/source releasenotes/build/html
[testenv:debug]
commands = oslo_debug_helper {posargs}


Loading…
Cancel
Save