📝 Document public API for downstream projects

maykinmedia · Feb 1, 2024 · d001a88 · d001a88
1 parent c67bd8f
commit d001a88
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -37,6 +37,7 @@
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.todo",
+    "sphinx.ext.intersphinx",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -59,3 +60,10 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = []
+
+intersphinx_mapping = {
+    "django": (
+        "http://docs.djangoproject.com/en/4.2/",
+        "http://docs.djangoproject.com/en/4.2/_objects/",
+    ),
+}
diff --git a/docs/index.rst b/docs/index.rst
@@ -27,6 +27,7 @@ Features
    :caption: Contents:
 
    quickstart
+   reference
    contributing
 
 

diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -128,3 +128,6 @@ Usage
 Should be plug and play - there is no additional frontend stuff.
 
 You can run ``python manage.py check`` to diagnose potential problems.
+
+We recommend putting a link in the admin user links to the
+``maykin_2fa:account_security`` view where users can manage their backup tokens.
diff --git a/docs/reference.rst b/docs/reference.rst
@@ -0,0 +1,16 @@
+=============
+API reference
+=============
+
+Decorators
+==========
+
+.. automodule:: maykin_2fa.decorators
+   :members:
+
+Test helpers
+============
+
+.. automodule:: maykin_2fa.test
+   :members:
+