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

[Doc] Fix missing Python class member documentation #975

Merged
merged 1 commit into from
Feb 10, 2021

Conversation

speth
Copy link
Member

@speth speth commented Feb 10, 2021

Sphinx 1.8 deprecated the 'autodoc_default_flags' option. It appears to have stopped working without warning in more recent versions, which means that the API docs don't include any of the member functions / member variables for any of the Python classes.

Changes proposed in this pull request

  • Use autodoc_default_options instead
  • Set the minimum Sphinx version to 2.0, since that's what this option requires

Checklist

  • There is a clear use-case for this code change
  • The commit message has a short title & references relevant issues
  • Build passes (scons build & scons test) and unit tests address code coverage
  • The pull request is ready for review

Sphinx 1.8 deprecated the 'autodoc_default_flags' option. It appears
to have stopped working without warning in more recent versions.
@speth speth merged commit 4f265d1 into Cantera:main Feb 10, 2021
@speth speth deleted the fix-sphinx branch May 23, 2021 02:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants