Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use of deprecated Sphinx config value #2270

Closed
RCreyghton opened this issue Sep 18, 2018 · 1 comment · Fixed by #2857
Closed

Use of deprecated Sphinx config value #2270

RCreyghton opened this issue Sep 18, 2018 · 1 comment · Fixed by #2857

Comments

@RCreyghton
Copy link

When make'ing sphinx on my configuration (python 2.7.15, sphinx 1.8.0) I get the following error:

Creating file /Users/ramon/espresso/esp40/buildall/doc/sphinx/modules.rst.
Warning, treated as error:
autodoc_default_flags is now deprecated. Please use autodoc_default_options instead.

I traced this to line 312 in build/doc/sphinx/conf.py, which uses autodoc_default_flags, which is indeed deprecated: http://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_default_flags
Replacing this as follows solved this issue for me:

autodoc_default_options = {
    'members': None,
    'show-inheritance': None,
    'undoc-members': None}

I suspect line 312 of /doc/sphinx/conf.py.in can use some updating.

@KaiSzuttor
Copy link
Member

We can only use autodoc_default_options after we require sphinx 1.8.

jngrad added a commit to jngrad/espresso that referenced this issue May 24, 2019
Using the solution provided by RCreyghton (espressomd#2270).
bors bot added a commit that referenced this issue May 24, 2019
2857: Update bibliography and Sphinx r=fweik a=jngrad

Description of changes:
- added support to newer versions of Sphinx (closes #2270)
   - upgradeed `conf.py` to v1.8+
   - fixed CSS rendering issue on v2.0.1
   - tested on v1.7.8/python2 and v2.0.1/python3
- removed unused features of the `conf.py` script
- fixed a Python class whose docstring was truncated by Sphinx
- merged our `icp.bib` into `zrefs.bib` to fix the outdated/broken/missing references


Co-authored-by: Jean-Noël Grad <jgrad@icp.uni-stuttgart.de>
@bors bors bot closed this as completed in #2857 May 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants