Description

sawyerbfuller

opened on Apr 2, 2021

Issue body actions

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

1. murrayrm commented on Apr 2, 2021

   

   murrayrm

   on Apr 2, 2021

   Member

   More actions

   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.
2. murrayrm commented on Apr 3, 2021

   

   murrayrm

   on Apr 3, 2021

   Member

   More actions

   Note: dynamics appears 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 html in doc/ and then open _build/html/index.html to see what the documentation will look like.
3. sawyerbfuller commented on Apr 6, 2021

   

   sawyerbfuller

   on Apr 6, 2021

   ContributorAuthor

   More actions

   @murrayrm I see, you're right, dynamics does 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 (inputs and outputs are included rather than ninputs and noutputs, and dt is not included), and there is no information about them. I'll follow that link and see if I can find what to do there.
4. murrayrm

   added

   documentation

   on Jun 12, 2021
5. murrayrm

   linked a pull request that will close this issueDocumentation updates #633on Jun 13, 2021
6. murrayrm

   self-assigned this

   on Jun 13, 2021
7. murrayrm

   closed this as completedin #633on Jun 16, 2021

Issue actions