Skip to content

Commit

Permalink
Extend README
Browse files Browse the repository at this point in the history
  • Loading branch information
hagenw committed Jan 10, 2024
1 parent 8bf0ff9 commit f94c74b
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,17 @@
sphinx-apipages
===============

**sphinx-apipages** is a sphinx_ extension,
that splits your API documentation
into several sub-pages.
**sphinx-apipages** is a sphinx_ extension
for API documentation.
It uses the autosummary_ and autodoc_ directives,
and creates sub-pages
for each function and class.

Have a look at the installation_ and usage_ instructions.


.. _autodoc: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
.. _autosummary: https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html
.. _installation: https://audeering.github.io/sphinx-apipages/install.html
.. _sphinx: https://www.sphinx-doc.org/en/master/
.. _usage: https://audeering.github.io/sphinx-apipages/usage.html

0 comments on commit f94c74b

Please sign in to comment.