Add documentation by Sphinx

This commit is contained in:
Jonathan Harker 2024-09-26 17:29:50 +12:00
parent 0bf0531fd6
commit 53c96a2ea5
9 changed files with 157 additions and 1 deletions

27
docs/source/index.rst Normal file
View file

@ -0,0 +1,27 @@
.. Setclass documentation master file, created by
sphinx-quickstart on Sat Sep 21 12:30:24 2024.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Setclass documentation
======================
.. include:: readme.md
.. contents::
:depth: 2
:local:
.. toctree::
:maxdepth: 2
:includehidden:
modules.rst
setclass.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`