Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Attempting sphinxcontrib.apidoc to generate low-level API docs. #251

Merged
merged 2 commits into from
Jan 16, 2024
Merged

Attempting sphinxcontrib.apidoc to generate low-level API docs. #251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd5d7d5
Integrates sphinxcontrib.apidoc to generate low-level API docs.
jamie-lemon Jan 16, 2024
7ca9923
Updates doc.index.rst and requirements.rst for Read the Docs.
jamie-lemon Jan 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/modules.rst → doc/api/modules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
API Documentation
=================
pdf2docx
========

.. toctree::
:maxdepth: 4
Expand Down
7 changes: 6 additions & 1 deletion doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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']

Expand Down
10 changes: 8 additions & 2 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions doc/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ rst2pdf
sphinx==5.3.0
autodoc
sphinx_rtd_theme
sphinxcontrib.apidoc
Loading