Opened 7 years ago

Last modified 21 months ago

#2087 new enhancement

move dev docs to sphinx

Reported by: dustin Owned by:
Priority: major Milestone: 0.9.+
Version: master Keywords: docs
Cc: rutsky

Description

This may involve the autodoc extension, or just copying a lot of stuff out of docstrings. Either way, the apidocs target should go away. If docstrings are still in the code, they should be there *only* for people actually looking at the code.

Change History (4)

comment:1 Changed 6 years ago by dustin

  • Milestone changed from 0.8.6 to 0.9.+

The dev docs in sphinx are coming along nicely, so I'm going to bump this ahead to 0.9.+ to remind myself to remove docstrings when that's complete.

comment:2 Changed 3 years ago by sa2ajj

What this ticket is about? By just reading it, I do not understand where we are.

comment:3 Changed 3 years ago by dustin

The idea was to finally move all of the developer-oriented docs that are currently in docstrings into sphinx documents, and then delete the docstrings.

comment:4 Changed 21 months ago by rutsky

  • Cc rutsky added
Note: See TracTickets for help on using tickets.