Merge pull request #251 from ArtifexSoftware/sphinxcontrib.apidoc

Adds sphinxcontrib.apidoc to generate low-level API docs.
ArtifexSoftware · Jan 16, 2024 · 2f4445b · 2f4445b
2 parents 644f784 + 7ca9923
commit 2f4445b
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 5 deletions.
diff --git a/doc/modules.rst → doc/api/modules.rst b/doc/modules.rst → doc/api/modules.rst
@@ -1,5 +1,5 @@
-API Documentation
-=================
+pdf2docx
+========
 
 .. toctree::
    :maxdepth: 4

diff --git a/doc/conf.py b/doc/conf.py
@@ -40,9 +40,14 @@ def get_version(fname):
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc'
+    'sphinxcontrib.apidoc'
 ]
 
+apidoc_module_dir = '../pdf2docx'
+apidoc_output_dir = 'api'
+apidoc_excluded_paths = []
+apidoc_separate_modules = True
+
 # Add any paths that contain templates here, relative to this directory.
 # templates_path = ['_templates']
 

diff --git a/doc/index.rst b/doc/index.rst
@@ -9,12 +9,18 @@ generate docx file with ``python-docx``.
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
+   :caption: USER GUIDE
 
    installation
    quickstart
    techdoc
-   modules
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: API DOCUMENTATION
+
+   api/modules
 
 
 Indices and tables

diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -4,3 +4,4 @@ rst2pdf
 sphinx==5.3.0
 autodoc
 sphinx_rtd_theme
+sphinxcontrib.apidoc