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

Sphinx CI job fails on Sphinx v2.4.0 #3476

Closed
espresso-ci opened this issue Feb 12, 2020 · 2 comments · Fixed by #3480
Closed

Sphinx CI job fails on Sphinx v2.4.0 #3476

espresso-ci opened this issue Feb 12, 2020 · 2 comments · Fixed by #3480
Assignees

Comments

@espresso-ci
Copy link

https://gitlab.icp.uni-stuttgart.de/espressomd/espresso/pipelines/11044

@jngrad jngrad self-assigned this Feb 12, 2020
@jngrad jngrad changed the title CI build failed for merged PR Sphinx CI job fails on Sphinx v2.4.0 Feb 12, 2020
@jngrad jngrad mentioned this issue Feb 12, 2020
@jngrad
Copy link
Member

jngrad commented Feb 12, 2020

I'm investigating. cuda:10.1 was rolled back to an earlier version for the time being.

@jngrad
Copy link
Member

jngrad commented Feb 13, 2020

In our CMake logic, we have:

${SPHINX_API_DOC_EXE}
-f
-P
-o ${SPHINX_BASE}
${SPHINX_PYTHON_DIR}
${EXCLUDE}

where the -P flag means documenting private members, i.e. all classes and methods starting with a single underscore symbol. This flag was introduced in d8c56d7, a few days after the private-members option was added in c5e9fa2. However, the -P never had any effect due to a bug that only got fixed recently by Sphinx 2.4.0. When we decided to stop documenting the private members in #1296, the private-members option was removed in 49262af but not the -P flag.

Now that cuda:10.1 has Sphinx 2.4.0, the private members are processed to generate the HTML output, revealing multiple errors in the docstrings. I'll fix those errors and remove the -P flag to hide private members again.

@jngrad jngrad added this to the Espresso 4.1.3 milestone Feb 13, 2020
@kodiakhq kodiakhq bot closed this as completed in #3480 Feb 13, 2020
kodiakhq bot added a commit that referenced this issue Feb 13, 2020
Fixes #3476

Description of changes:
- fix broken Sphinx syntax in docstrings of private members
- remove Sphinx apidoc `-P` flag (for Sphinx >= 2.4.0)
- remove documentation of inexistent features
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.

2 participants