Generate API docs with `../.venv/bin/sphinx-apidoc -e -f -M --remove-old -o reference ../src ../src/icalendar/tests`

docs/index.rst

@@ -21,9 +21,9 @@ Contents
 ========
 
 .. toctree::
-    :caption: Contribute
+    :caption: API Reference
 
-    api/index
+    reference/icalendar
 
 
 .. toctree::

docs/reference/api.rst

@@ -1,92 +0,0 @@
-API Reference
--------------
-
-icalendar.attr
-++++++++++++++
-
-.. automodule:: icalendar.attr
-   :members:
-
-icalendar.alarms
-++++++++++++++++
-
-.. automodule:: icalendar.alarms
-   :members:
-
-icalendar.cal
-+++++++++++++
-
-.. automodule:: icalendar.cal
-   :members:
-
-icalendar.caselessdict
-++++++++++++++++++++++
-
-.. automodule:: icalendar.caselessdict
-   :members:
-
-icalendar.cli
-+++++++++++++
-
-.. automodule:: icalendar.cli
-   :members:
-
-icalendar.enums
-+++++++++++++++
-
-.. automodule:: icalendar.enums
-   :members:
-
-icalendar.error
-+++++++++++++++
-
-.. automodule:: icalendar.error
-   :members:
-
-icalendar.param
-+++++++++++++++
-
-.. automodule:: icalendar.param
-   :members:
-
-icalendar.parser
-++++++++++++++++
-
-.. automodule:: icalendar.parser
-   :members:
-
-icalendar.parser_tools
-++++++++++++++++++++++
-
-.. automodule:: icalendar.parser_tools
-   :members:
-
-icalendar.prop
-++++++++++++++
-
-.. automodule:: icalendar.prop
-   :members:
-
-icalendar.tools
-+++++++++++++++
-
-.. automodule:: icalendar.tools
-   :members:
-
-icalendar.timezone
-++++++++++++++++++
-
-.. automodule:: icalendar.timezone
-   :members:
-
-.. automodule:: icalendar.timezone.tzid
-   :members:
-
-.. automodule:: icalendar.timezone.tzp
-   :members:
-
-icalendar.version
-+++++++++++++++++
-
-.. automodule:: icalendar.version
-   :members:

docs/reference/icalendar.alarms.rst

@@ -0,0 +1,7 @@
+icalendar.alarms module
+=======================
+
+.. automodule:: icalendar.alarms
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/reference/icalendar.attr.rst

@@ -0,0 +1,7 @@
+icalendar.attr module
+=====================
+
+.. automodule:: icalendar.attr
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/reference/icalendar.cal.rst

@@ -0,0 +1,7 @@
+icalendar.cal module
+====================
+
+.. automodule:: icalendar.cal
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/reference/icalendar.caselessdict.rst

@@ -0,0 +1,7 @@
+icalendar.caselessdict module
+=============================
+
+.. automodule:: icalendar.caselessdict
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/reference/icalendar.cli.rst

@@ -0,0 +1,7 @@
+icalendar.cli module
+====================
+
+.. automodule:: icalendar.cli
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/reference/icalendar.enums.rst

@@ -0,0 +1,7 @@
+icalendar.enums module
+======================
+
+.. automodule:: icalendar.enums
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/reference/icalendar.error.rst

@@ -0,0 +1,7 @@
+icalendar.error module
+======================
+
+.. automodule:: icalendar.error
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/reference/icalendar.param.rst

@@ -0,0 +1,7 @@
+icalendar.param module
+======================
+
+.. automodule:: icalendar.param
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/reference/icalendar.parser.rst

@@ -0,0 +1,7 @@
+icalendar.parser module
+=======================
+
+.. automodule:: icalendar.parser
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/reference/icalendar.parser_tools.rst

@@ -0,0 +1,7 @@
+icalendar.parser\_tools module
+==============================
+
+.. automodule:: icalendar.parser_tools
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/reference/icalendar.prop.rst

@@ -0,0 +1,7 @@
+icalendar.prop module
+=====================
+
+.. automodule:: icalendar.prop
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/reference/icalendar.rst

@@ -0,0 +1,35 @@
+icalendar package
+=================
+
+.. automodule:: icalendar
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   icalendar.timezone
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   icalendar.alarms
+   icalendar.attr
+   icalendar.cal
+   icalendar.caselessdict
+   icalendar.cli
+   icalendar.enums
+   icalendar.error
+   icalendar.param
+   icalendar.parser
+   icalendar.parser_tools
+   icalendar.prop
+   icalendar.tools
+   icalendar.version

docs/reference/icalendar.timezone.equivalent_timezone_ids.rst

@@ -0,0 +1,7 @@
+icalendar.timezone.equivalent\_timezone\_ids module
+===================================================
+
+.. automodule:: icalendar.timezone.equivalent_timezone_ids
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/reference/icalendar.timezone.equivalent_timezone_ids_result.rst

@@ -0,0 +1,7 @@
+icalendar.timezone.equivalent\_timezone\_ids\_result module
+===========================================================
+
+.. automodule:: icalendar.timezone.equivalent_timezone_ids_result
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/reference/icalendar.timezone.provider.rst

@@ -0,0 +1,7 @@
+icalendar.timezone.provider module
+==================================
+
+.. automodule:: icalendar.timezone.provider
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/reference/icalendar.timezone.pytz.rst

@@ -0,0 +1,7 @@
+icalendar.timezone.pytz module
+==============================
+
+.. automodule:: icalendar.timezone.pytz
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/reference/icalendar.timezone.rst

@@ -0,0 +1,22 @@
+icalendar.timezone package
+==========================
+
+.. automodule:: icalendar.timezone
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   icalendar.timezone.equivalent_timezone_ids
+   icalendar.timezone.equivalent_timezone_ids_result
+   icalendar.timezone.provider
+   icalendar.timezone.pytz
+   icalendar.timezone.tzid
+   icalendar.timezone.tzp
+   icalendar.timezone.windows_to_olson
+   icalendar.timezone.zoneinfo

docs/reference/icalendar.timezone.tzid.rst

@@ -0,0 +1,7 @@
+icalendar.timezone.tzid module
+==============================
+
+.. automodule:: icalendar.timezone.tzid
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/reference/icalendar.timezone.tzp.rst

@@ -0,0 +1,7 @@
+icalendar.timezone.tzp module
+=============================
+
+.. automodule:: icalendar.timezone.tzp
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/reference/icalendar.timezone.windows_to_olson.rst

@@ -0,0 +1,7 @@
+icalendar.timezone.windows\_to\_olson module
+============================================
+
+.. automodule:: icalendar.timezone.windows_to_olson
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/reference/icalendar.timezone.zoneinfo.rst

@@ -0,0 +1,7 @@
+icalendar.timezone.zoneinfo module
+==================================
+
+.. automodule:: icalendar.timezone.zoneinfo
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/reference/icalendar.tools.rst

@@ -0,0 +1,7 @@
+icalendar.tools module
+======================
+
+.. automodule:: icalendar.tools
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/reference/icalendar.version.rst

@@ -0,0 +1,7 @@
+icalendar.version module
+========================
+
+.. automodule:: icalendar.version
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/reference/index.rst

@@ -1,8 +0,0 @@
--------------
-API Reference
--------------
-
-.. toctree::
-    :caption: API Reference
-
-

docs/reference/modules.rst

@@ -0,0 +1,7 @@
+src
+===
+
+.. toctree::
+   :maxdepth: 4
+
+   icalendar