-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve the structure of the API docs #33
Comments
Also appropriately marks some symbols that shouldn't be accessed externally as private. Initial steps towards to addressing #33
Also appropriately marks some symbols that shouldn't be accessed externally as private. Initial steps towards to addressing #33
As part of this, the docstrings should be reformatted to use a fully supported docstring syntax. The default option is https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html, but that's pretty boilerplate heavy. So instead, I'm leaning towards enabling the https://sphinxcontrib-napoleon.readthedocs.io/en/latest/index.html and using Google-style docstrings: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html#example-google (that's an aesthetic preference, as I genuinely don't like the way the NumPy syntax looks when reading code) This will mean turning on the |
* Enable docstring linting for public API elements * Linting enforces the use of Google-style docstrings * Update the names and visibility of various API elements * Add missing docstrings to public API elements * Fix some docstring text formatting issues * Add release notes for these changes and docs process changes Continues progress on issue #33 (improving the API docs).
* Enable docstring linting for public API elements * Linting enforces the use of Google-style docstrings * Update the names and visibility of various API elements * Add missing docstrings to public API elements * Fix some docstring text formatting issues * Add release notes for these changes and docs process changes * Bump the dev bundle version to ensure test envs are updated Continues progress on issue #33 (improving the API docs).
The current API docs are essentially just a
sphinx-autogen
dump with a bit of manual cleanup to address misfires like including the entirestr
,Sequence
,Mapping
, anddict
APIs on types that implement those interfaces.As parts of the API stabilise, their documentation should move away from relying on
autosummary
and towards regulartoctree
directives.Public functions that are missing docstrings should have them added.
The
TypedDict
metadata is also incorrect (the mapping fields are listed as attributes, which is technically true of the class definition, but not true of the objects that a typechecker will classify as providing that interface).Finally, while the one-page-per-entity layout is apparently more search-engine friendly, it makes it hard to see how the various interfaces relate to each other, so it's likely worth pushing at least the module level functions and the basic type definitions up to the relevant module pages.
The text was updated successfully, but these errors were encountered: