Fixes separate pages for api reference.

josh-silvas · josh-silvas · commit 811af15298c2 · 2021-06-23T11:06:23.000-05:00
Updates README.md to address rendering error.
Adds build directory to .gitignore
diff --git a/.gitignore b/.gitignore
@@ -286,3 +286,6 @@ fabric.properties
 .vscode/*
 
 *.code-workspace
+
+## Sphinx Documentation ##
+docs/build
diff --git a/README.md b/README.md
@@ -22,7 +22,7 @@ A.sync_from(B)
 A.sync_to(B)
 ```
 
-You may wish to peruse the [`diffsync` GitHub topic](https://github.com/topics/diffsync) for examples of projects using this library.
+You may wish to peruse the `diffsync` [GitHub topic](https://github.com/topics/diffsync) for examples of projects using this library.
 
 # Getting started
 
diff --git a/diffsync/__init__.py b/diffsync/__init__.py
@@ -37,7 +37,7 @@ class DiffSyncModel(BaseModel):
     This class has several underscore-prefixed class variables that subclasses should set as desired; see below.
 
     NOTE: The groupings _identifiers, _attributes, and _children are mutually exclusive; any given field name can
-          be included in **at most** one of these three tuples.
+    be included in **at most** one of these three tuples.
     """
 
     _modelname: ClassVar[str] = "diffsyncmodel"
diff --git a/docs/source/api/diffsync.diff.rst b/docs/source/api/diffsync.diff.rst
@@ -0,0 +1,7 @@
+diffsync.diff
+=============
+
+.. automodule:: diffsync.diff
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/diffsync.enum.rst b/docs/source/api/diffsync.enum.rst
@@ -0,0 +1,7 @@
+diffsync.enum
+=============
+
+.. automodule:: diffsync.enum
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/diffsync.exceptions.rst b/docs/source/api/diffsync.exceptions.rst
@@ -0,0 +1,7 @@
+diffsync.exceptions
+===================
+
+.. automodule:: diffsync.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/diffsync.helpers.rst b/docs/source/api/diffsync.helpers.rst
@@ -0,0 +1,7 @@
+diffsync.helpers
+================
+
+.. automodule:: diffsync.helpers
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/diffsync.logging.rst b/docs/source/api/diffsync.logging.rst
@@ -0,0 +1,7 @@
+diffsync.logging
+================
+
+.. automodule:: diffsync.logging
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/diffsync.rst b/docs/source/api/diffsync.rst
@@ -7,50 +7,12 @@ API Reference
    :show-inheritance:
 
 
-diffsync.diff
--------------
-
-.. automodule:: diffsync.diff
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-diffsync.enum
--------------
-
-.. automodule:: diffsync.enum
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-diffsync.exceptions
--------------------
-
-.. automodule:: diffsync.exceptions
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-diffsync.helpers
-----------------
-
-.. automodule:: diffsync.helpers
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-diffsync.logging
-----------------
-
-.. automodule:: diffsync.logging
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-diffsync.utils
---------------
-
-.. automodule:: diffsync.utils
-   :members:
-   :undoc-members:
-   :show-inheritance:
+.. toctree::
+   :maxdepth: 4
+
+   diffsync.diff
+   diffsync.enum
+   diffsync.exceptions
+   diffsync.helpers
+   diffsync.logging
+   diffsync.utils
diff --git a/docs/source/api/diffsync.utils.rst b/docs/source/api/diffsync.utils.rst
@@ -0,0 +1,7 @@
+diffsync.utils
+==============
+
+.. automodule:: diffsync.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -90,7 +90,7 @@ def remove_module_docstring(app, what, name, obj, options, lines):
 
 def run_apidoc(_):
     """Adds the sphinx-apidoc command as a callback during the build process."""
-    main(["-MTf", "-t", f"{CURR_DIR}/template/api", "-o", f"{CURR_DIR}/api", f"{ROOT_DIR}/{TOOL_CONFIG['name']}"])
+    main(["-MTfe", "-t", f"{CURR_DIR}/template/api", "-o", f"{CURR_DIR}/api", f"{ROOT_DIR}/{TOOL_CONFIG['name']}"])
 
 
 def setup(app):
diff --git a/docs/source/template/api/module.rst_t b/docs/source/template/api/module.rst_t
@@ -0,0 +1,9 @@
+{%- if show_headings %}
+{{- basename | e | heading }}
+
+{% endif -%}
+.. automodule:: {{ qualname }}
+{%- for option in automodule_options %}
+   :{{ option }}:
+{%- endfor %}
+
