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

Update documentation #3480

Merged
merged 7 commits into from
Feb 13, 2020
Merged

Update documentation #3480

merged 7 commits into from
Feb 13, 2020

Conversation

jngrad
Copy link
Member

@jngrad jngrad commented 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

Fix regression of 49262af revealed by Sphinx 2.4.0.
This documentation was commented out. Most paragraphs were missing
keywords and variable names. Many of them described Tcl features
that weren't ported to Python.
@jngrad jngrad added this to the Espresso 4.1.3 milestone Feb 13, 2020
@jngrad jngrad requested a review from KaiSzuttor February 13, 2020 14:13
@codecov
Copy link

codecov bot commented Feb 13, 2020

Codecov Report

Merging #3480 into python will increase coverage by <1%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           python   #3480    +/-   ##
=======================================
+ Coverage      86%     87%   +<1%     
=======================================
  Files         538     537     -1     
  Lines       24527   24460    -67     
=======================================
- Hits        21291   21289     -2     
+ Misses       3236    3171    -65
Impacted Files Coverage Δ
src/core/particle_data.cpp 97% <0%> (-1%) ⬇️
src/core/electrostatics_magnetostatics/p3m.cpp 85% <0%> (-1%) ⬇️
src/core/random.hpp 100% <0%> (+21%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b302c32...cad96d6. Read the comment docs.

@jngrad jngrad added the automerge Merge with kodiak label Feb 13, 2020
@kodiakhq kodiakhq bot merged commit eb56b21 into espressomd:python Feb 13, 2020
@jngrad jngrad deleted the fix-3476 branch January 18, 2022 12:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sphinx CI job fails on Sphinx v2.4.0
2 participants