Versions Compared

Old Version 5

changes.mady.by.user Sylvia Pearce

Saved on

compared with

New Version Current

changes.mady.by.user Feanil Patel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

/wiki/spaces/DOC/pages/113607066: Notes from a meeting with Ben Patterson and members of the documentation team about silent build failures in API documentation.

/wiki/spaces/DOC/pages/108659218: Wiki page of questions for Peter Desjardins, who was maintaining our API documentation before his departure in September. There are several items about API documentation.

Tools

API documentation tools have historically used .rst files, Python docstrings together with the Sphinx autodoc extension, GitHub, and ReadTheDocs. For more information, see Documenting APIs and Sphinx Autodoc Content.