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

Add support for Sphinx 4 #600

Closed
5 tasks done
rly opened this issue May 11, 2021 · 1 comment · Fixed by #601
Closed
5 tasks done

Add support for Sphinx 4 #600

rly opened this issue May 11, 2021 · 1 comment · Fixed by #601
Labels
category: bug errors in the code or code behavior

Comments

@rly
Copy link
Contributor

rly commented May 11, 2021

Description

Sphinx 4.0 was released a few days ago. Using Sphinx 4 to generate the API docs results in:

Running Sphinx v4.0.1
making output directory... done
loading intersphinx inventory from https://docs.python.org/3.8/objects.inv...
loading intersphinx inventory from https://numpy.org/doc/stable/objects.inv...
loading intersphinx inventory from https://docs.scipy.org/doc/scipy/reference/objects.inv...
loading intersphinx inventory from https://matplotlib.org/objects.inv...
loading intersphinx inventory from http://docs.h5py.org/en/latest/objects.inv...
loading intersphinx inventory from https://pandas.pydata.org/pandas-docs/stable/objects.inv...
intersphinx inventory has moved: http://docs.h5py.org/en/latest/objects.inv -> https://docs.h5py.org/en/latest/objects.inv
generating gallery...

Configuration error:
Unknown key(s) in sphinx_gallery_conf:
'download_section_examples', did you mean 'download_all_examples'?

There may be other breaking changes to account for.
https://www.sphinx-doc.org/en/master/changes.html

Environment

Python Executable: Conda
Python Version: Python 3.8
Operating System: Windows
HDMF Version: dev

Checklist

  • Have you ensured the bug was not already reported ?
  • Have you included a brief and descriptive title?
  • Have you included a clear description of the problem you are trying to solve?
  • Have you included a minimal code snippet that reproduces the issue you are encountering?
  • Have you checked our Contributing document?
@rly rly added the category: bug errors in the code or code behavior label May 11, 2021
@rly
Copy link
Contributor Author

rly commented May 11, 2021

Actually this is a sphinx_gallery issue, but we should check for Sphinx 4 compatibility as well.

rly added a commit that referenced this issue May 11, 2021
Where 'download_section_examples' is now an unknown key. Fix #600.
@rly rly closed this as completed in #601 May 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: bug errors in the code or code behavior
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant