feat: Generate API docs

2024-10-17 21:36:53 -07:00 · 2024-10-17 21:36:53 -07:00 · d39f501d4b
parent 8dd59bb891
commit d39f501d4b
5 changed files with 20 additions and 1 deletions
--- a/docs/_config.yml
+++ b/docs/_config.yml
@ -68,3 +68,4 @@ sphinx:

  extra_extensions:
    - sphinx.ext.intersphinx
+    - sphinx.ext.autodoc
--- a/docs/_toc.yml
+++ b/docs/_toc.yml
@ -5,3 +5,7 @@ parts:
  chapters:
  - file: goal
  - file: proof_search
+- caption: API Documentation
+  chapters:
+  - file: api-server
+  - file: api-search
--- a/docs/api-search.rst
+++ b/docs/api-search.rst
@ -0,0 +1,5 @@
+Search
+=============
+
+.. automodule:: pantograph.search
+    :members:
--- a/docs/api-server.rst
+++ b/docs/api-server.rst
@ -0,0 +1,5 @@
+Server
+=============
+
+.. automodule:: pantograph.server
+    :members:
--- a/pantograph/server.py
+++ b/pantograph/server.py
@ -31,7 +31,11 @@ class ServerError(Exception):

 DEFAULT_CORE_OPTIONS=["maxHeartbeats=0", "maxRecDepth=100000"]

+
 class Server:
+    """
+    Main interaction instance with Pantograph
+    """

    def __init__(self,
                 imports=["Init"],