Add API docs. Closes #245.

python · Aug 7, 2023 · d5399ef · d5399ef
1 parent e8ba13d
commit d5399ef
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 3 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,26 @@
+=============
+API Reference
+=============
+
+``importlib_resources`` module
+------------------------------
+
+.. automodule:: importlib_resources
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: importlib_resources.abc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: importlib_resources.readers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: importlib_resources.simple
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/conf.py b/docs/conf.py
@@ -34,6 +34,7 @@
 
 # Be strict about any broken references
 nitpicky = True
+nitpick_ignore = []
 
 # Include Python intersphinx mapping to prevent failures
 # jaraco/skeleton#51
@@ -46,3 +47,10 @@
 autodoc_preserve_defaults = True
 
 extensions += ['jaraco.tidelift']
+
+nitpick_ignore.extend(
+    [
+        ('py:class', 'module'),
+        ('py:class', '_io.BufferedReader'),
+    ]
+)
diff --git a/docs/index.rst b/docs/index.rst
@@ -31,9 +31,10 @@ The documentation here includes a general :ref:`usage <using>` guide and a
    :maxdepth: 2
    :caption: Contents:
 
-   using.rst
-   migration.rst
-   history.rst
+   using
+   api
+   migration
+   history
 
 .. tidelift-referral-banner::