Skip to content

Commit a487028

Browse files
fix autodoc generation
1 parent 1f8cabc commit a487028

File tree

3 files changed

+5
-2
lines changed

3 files changed

+5
-2
lines changed

.readthedocs.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
# Required
66
version: 2
77

8+
# Build all formats (HTML, epub, PDF)
9+
formats: all
10+
811
# Set the version of Python and other tools you might need
912
build:
1013
os: ubuntu-22.04

docs/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
# add these directories to sys.path here. If the directory is relative to the
1717
# documentation root, use os.path.abspath to make it absolute, like shown here.
1818
# sys.path.insert(0, os.path.abspath('.'))
19-
sys.path.insert(0, os.path.abspath(".."))
19+
sys.path.insert(0, os.path.abspath("../src"))
2020

2121
extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"]
2222

docs/pylibftdi.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ pylibftdi Package
4343
:show-inheritance:
4444

4545
:mod:`serial_device` Module
46-
---------------------
46+
---------------------------
4747

4848
.. automodule:: pylibftdi.serial_device
4949
:members:

0 commit comments

Comments
 (0)