Skip to content

Fix empty documentation pages (API reference, license, basic example) #90

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

Merged
keithlostracco merged 1 commit into from
May 28, 2026
Merged

Fix empty documentation pages (API reference, license, basic example) #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
sphinx>=7.3
sphinx-autoapi>=3.1
astroid<4 # sphinx-autoapi 3.5 calls AstroidBuilder() without the manager arg astroid 4 requires
furo
sphinx-copybutton
numpydoc
Expand Down
1 change: 1 addition & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import os
autoapi_dirs = [os.path.dirname(touchpy.__file__)]
autoapi_type = "python"
autoapi_file_patterns = ["*.pyi", "*.py"]

autoapi_options = [ 'members', 'undoc-members', 'private-members', 'show-module-summary', 'special-members', 'imported-members', ]

Expand Down
10 changes: 6 additions & 4 deletions docs/source/examples/basic.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@
Basic Example
=============

The example below loads a ``.tox`` file, advances it for a fixed number of frames
via an ``on_frame`` callback, then unloads it to cleanly release resources. The same
script is available in the repository at ``examples/01_load_comp_basic.py``.

.. code-block:: python
:linenos:

code . . .
.. literalinclude:: ../../../examples/01_load_comp_basic.py
:language: python
:linenos:
2 changes: 1 addition & 1 deletion docs/source/license.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
License
=======

.. include:: ../../install/LICENSE.md
.. include:: ../../LICENSE.md
:parser: myst_parser.sphinx_
Loading
Loading