Some sphinx fixes and removed private and special members from sphinx… #1296
Conversation
|
How does this deal with |
|
@mkuron I don't quite get your point, this PR does not change anything of the documentation behavior besides removing private and special members. |
|
Isn't |
|
But aren't these properties documented in the ParticleHandle class? |
|
Only the ones that are automatically added, not the statically-declared ones in the base class. Just look at the sphinx documentation to see whether they show up with documentation or not. |
|
As far as I can see they show up in the documentation. Please counter-check yourself @mkuron . |
|
Since sphinx also includes inherited members, the ones @mkuron was mentioning are included. |
doc/sphinx/io.rst
Outdated
| import espressomd from espressomd import checkpointing import signal | ||
|
|
||
| checkpoint = checkpointing.Checkpointing(checkpoint\_id=“mycheckpoint”) | ||
| checkpoint = checkpointing.Checkpointing(checkpoint_id=“mycheckpoint”) |
There was a problem hiding this comment.
There are smart quotes used here (“”) instead of straight ones (""), which makes this invalid Python code. Since you're touching the line anyway, please fix this.
|
So we're good now? |
… documentation.
Fixes #1284