~mpontillo/maas/basic-speed-test-endpoint

Viewing all changes in revision 5575.

  • Committer: MAAS Lander
  • Author(s): Mike Pontillo
  • Date: 2016-11-30 00:35:42 UTC
  • mfrom: (5573.1.3 api-doc-rst-improvements)
  • Revision ID: maas_lander-20161130003542-vny6m0i212029wfg
[r=blake-rouse][bug=][author=mpontillo] Improve generated reST in API documentation.

 * New feature: sections headers can now be used in API docstrings!
   - Previously, since API docstrings were always indented by
     two spaces, this was not possible. With this change, all
     docstrings are dedented and flush with the left margin.
   - This change should greatly expand our flexibility with
     regard to using reST formatting within the API docs.
 * Python-based template now uses ```` style sections
   instead of ---- style. This frees up the ---- style to be
   used in API docstrings, so that when printed in the MAAS CLI
   `--help`, it looks acceptable.
 * Each API operation is now its own section, rather than
   a ``<endpoint>[operation]`` string. This allows sections
   to be linked-to directly.
 * CSS selectors have been added to reduce the font size of
   API operation subtitle (and their children).
 * Table of contents depth for the API page has been limited,
   so that every API operation is not on the left-side ToC.

expand all expand all

Show diffs side-by-side

added added

removed removed

Lines of Context: