Repository navigation
__call__ and other new methods not described in sphinx docs #604
Description
I wanted to update docs to include new methods like call and dynamics, because they currently don't appear, e.g. in : https://python-control.readthedocs.io/en/0.9.0/generated/control.TransferFunction.html#control.TransferFunction
I think this might be somehow autogenerated, but I can't figure out how. The helpful "edit on github" button at top right gives a 404. Can somebody point me to how to make sure those methods appear in the next docs release?
Activity
murrayrm commentedon Apr 2, 2021
They are generated using Sphinx, with the source files sitting in
doc/. Some information is pulled from docstrings, but you can also put in documentation separately.murrayrm commentedon Apr 3, 2021
Note:
dynamicsappears correctly in StateSpace documentation.For
__call__, it looks like we may have to turn on sphinx processing of special-members. See autodoc documentation. I tried playing with this, but couldn't get it to work. Will take more investigation.If you have sphinx installed locally, you can run
make htmlindoc/and then open_build/html/index.htmlto see what the documentation will look like.sawyerbfuller commentedon Apr 6, 2021
@murrayrm I see, you're right,
dynamicsdoes appear in the sstatespace doc, just not in the transferFunction doc, as you would expect. I'll take a look at the link you sent for autodoc.Another issue I noticed is that the attribues are neither correct in name (
inputsandoutputsare included rather thanninputsandnoutputs, anddtis not included), and there is no information about them. I'll follow that link and see if I can find what to do there.