Skip to content
Permalink
Browse files

docs: update to sphinx 2.1.1

This needs minor fixes in doc/conf.py to adjust to upstream changes.
sphinx-apidoc is no longer developed, so we should probably move to
sphinx-autoapi in the future.

Signed-off-by: Jan Luebbe <jlu@pengutronix.de>
  • Loading branch information...
jluebbe committed Jun 12, 2019
1 parent 44be6b0 commit 90eaaaf19809698a1f37cb6845783fb36f6a3893
Showing with 7 additions and 5 deletions.
  1. +2 −2 doc-requirements.txt
  2. +5 −3 doc/conf.py
@@ -1,3 +1,3 @@
Sphinx==1.8.3
sphinx_rtd_theme==0.4.2
Sphinx==2.1.1
sphinx_rtd_theme==0.4.3
docutils==0.14
@@ -168,7 +168,9 @@
# -- Options for autodoc --------------------------------------------------

autodoc_member_order = 'bysource'
autodoc_default_flags = ['special-members']
autodoc_default_options = {
'special-members': True,
}
autodoc_mock_imports = ['onewire',
'txaio',
'autobahn',
@@ -190,10 +192,10 @@
sys.modules[mod] = Mock()

def run_apidoc(app):
from sphinx.apidoc import main
from sphinx.ext.apidoc import main
module = os.path.abspath(os.path.join(app.srcdir, '..', 'labgrid'))
output = os.path.abspath(os.path.join(app.srcdir, 'modules'))
cmd = ['sphinx-apidoc', module, '-M', '-H', 'Modules', '-o', output]
cmd = [module, '-a', '-M', '-H', 'Modules', '-o', output]
main(cmd)

def setup(app):

0 comments on commit 90eaaaf

Please sign in to comment.
You can’t perform that action at this time.