simon-git: spigot (master): Simon Tatham
Commits to Tartarus hosted VCS
tartarus-commits at lists.tartarus.org
Wed Oct 25 20:56:48 BST 2017
TL;DR:
311949b Reorganise the Python documentation.
Repository: https://git.tartarus.org/simon/spigot.git
On the web: https://git.tartarus.org/?p=simon/spigot.git
Branch updated: master
Committer: Simon Tatham <anakin at pobox.com>
Date: 2017-10-25 20:56:48
commit 311949b93246f29de11f6ea50023f7188bd50797
web diff https://git.tartarus.org/?p=simon/spigot.git;a=commitdiff;h=311949b93246f29de11f6ea50023f7188bd50797;hp=9f500cefdd18d35e7472dae9eb57db8e543c283f
Author: Simon Tatham <anakin at pobox.com>
Date: Wed Oct 25 20:56:39 2017 +0100
Reorganise the Python documentation.
By poking around other people's Sphinx docs, I found out how you're
supposed to arrange to put sections and subsections inside the mostly
autodoc'ed list of functions and classes and methods. So now the API
documentation is divided more or less sensibly up into sections.
Particular changes: I've switched round the order of the class-method
construction functions and the top-level ones, so that things like
spigot.fraction and spigot.eval get top billing and the class method
versions are labelled as afterthought equivalents. And I've moved the
entire section about all the rounding modes out of the ridiculous
place it was previously in (inside the documentation for to_int) into
a top-level section of its own which can be referred to in a sensible
way from all the necessary places.
python-doc/api.rst | 816 ++++++++++++++++++++++-----------
python-doc/index.rst | 4 -
python-module/__init__.py | 1070 ++++++++++++++++++--------------------------
python-module/internal.cpp | 4 +-
4 files changed, 1006 insertions(+), 888 deletions(-)
More information about the tartarus-commits
mailing list