Skip to content

Commit cad604b

Browse files
committed
make sphinx work
1 parent 373f320 commit cad604b

File tree

4 files changed

+8
-4
lines changed

4 files changed

+8
-4
lines changed

ci/rtd-requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# RTD is currently installing 1.5.3, which has a bug in :lineno-match:
2-
sphinx >= 1.6.1
2+
sphinx >= 1.7.0
33
sphinx_rtd_theme
44
sphinxcontrib-trio

docs/source/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,12 @@
2828
nitpick_ignore = [
2929
# Format is ("sphinx reference type", "string"), e.g.:
3030
("py:obj", "bytes-like"),
31+
("py:class", "trio_gpio.gpio.Chip"),
32+
("py:class", "trio_gpio.gpio.Line"),
3133
]
3234

35+
autodoc_inherit_docstrings = False
36+
3337
# -- General configuration ------------------------------------------------
3438

3539
# If your documentation needs a minimal Sphinx version, state it here.

docs/source/usage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ assuming there's more than one.
2828
The ``consumer`` argument is optional. It describes your code to the kernel, so that
2929
a program which enumerates GPIO users can display who currently uses the pin in question.
3030

31-
.. autofunction:: open_chip
31+
.. autofunction:: trio_gpio.open_chip
3232

3333
Referring to a line
3434
-------------------

trio_gpio/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
import sys
44

5-
from ._version import __version__
5+
from ._version import __version__ # noqa
66

77
from .gpio import Chip
8-
from .libgpiod import *
8+
from .libgpiod import * # noqa
99

1010
def open_chip(num=0, consumer=sys.argv[0]):
1111
"""Returns an object representing a GPIO chip.

0 commit comments

Comments
 (0)