Or by creating a changelog.Documentation blocks usually precede the element they refer to. You can incorporate your changelog simply by linking it: the sphinx read the docs theme available via pypi) won't be usable if you wish to release your package on the osrf build farm. You can find other default themes in Using a non-default theme (e.g. A good alternative but still a default theme is agogo: Leave that out (just as for uri module here) to only show documented functions and classes. Use undoc-members to show all functions and classes, even if they are undocumented. That will create the appropriate modules.rst and associated package name.rst files.Īn example module api file for sphinx looks like this (this is for rocon_uri): If you want to auto-generate all docs for everything, run the following after creating your package for the first time:
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |