Skip to content
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

Use sphinx-accessors-autosummary #4323

Merged
merged 4 commits into from
Aug 9, 2020
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
mention the sphinx extension in the internals documentation
keewis committed Aug 7, 2020
commit 5b9d88e29bc20a652e3fa2ad82cbf71ef4f89b9a
5 changes: 5 additions & 0 deletions doc/internals.rst
Original file line number Diff line number Diff line change
@@ -171,6 +171,11 @@ To help users keep things straight, please `let us know
for an open source library. In the future, we will maintain a list of accessors
and the libraries that implement them on this page.

To make documenting accessors with ``sphinx`` and ``sphinx.ext.autosummary``
easier, you can use `sphinx-ext-autosummary`_.

.. _sphinx-ext-autosummary: https://sphinx-autosummary-accessors.readthedocs.io/

.. _zarr_encoding:

Zarr Encoding Specification