| commit | 53fccd877c0af72669747990ca51597f01ea2aed | |
| author | Mats Wichmann <mats@linux.com> | |
| Thu, 16 May 2024 16:44:52 +0000 (16 10:44 -0600) | ||
| committer | Mats Wichmann <mats@linux.com> | |
| Thu, 16 May 2024 16:44:52 +0000 (16 10:44 -0600) | ||
| tree | 673c204847a44a2cc8fb60374fe7c68aebf730ef | treesnapshot (tar.gz zip) |
| parent | c33bb1a8a7db16f6fc0a2cf950b75a1c48d1e424 | commitdiff |
API Docs build adjustment.
For a "package" which has a main piece and submodules, the
main part is now processed before, rather than after, the submodules.
Usally there's introductory material (e.g. in the main module's
docstring) and it's more useful for this to appear at the top of
a page rather than down after all the submodules.
Made some docstring tweaks in two modules where the result didn't
look very good - Debug and PathList. For PathList, Sphinx doesn't
process both a class docstring and its __init__ method's docstring -
you get one of the other, so joined those together.
Signed-off-by: Mats Wichmann <mats@linux.com>
For a "package" which has a main piece and submodules, the
main part is now processed before, rather than after, the submodules.
Usally there's introductory material (e.g. in the main module's
docstring) and it's more useful for this to appear at the top of
a page rather than down after all the submodules.
Made some docstring tweaks in two modules where the result didn't
look very good - Debug and PathList. For PathList, Sphinx doesn't
process both a class docstring and its __init__ method's docstring -
you get one of the other, so joined those together.
Signed-off-by: Mats Wichmann <mats@linux.com>