-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Description
- Sphinx no longer adds the import and directory structure bits to the default setup file, but still needs them
- By default, Sphinx only includes class-level docstrings and not the
__init__ones, which clashes with VSCode which only auto-shows__init__docstrings and not class-level ones. We can change this by addingautoclass_content = 'both'. - We should mention readthedocs.io - people wanted to know how to convert the HTML into a website
- The default
alabasterstyle is hard to read and has mimimal differentiation between blocks - we should introduce themes by for ewxample switching toclassic. - Learners didn't grok that the
.rstfiles are just text files - we should get them to write a little intro - They also all wanted to add multiple files to their docs, so a quick description of how to add extra automodules would be good.
- Some installations provide IPv6 links for the python server, we should specify localhost
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels