Skip to content

Commit 85cb3cc

Browse files
committed
Fix docs
1 parent 6628123 commit 85cb3cc

6 files changed

Lines changed: 13 additions & 5 deletions

File tree

doc/source/api.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ pathspec.pathspec
1919
:show-inheritance:
2020
:special-members: __init__, __eq__, __len__
2121

22+
.. autoclass:: Self
23+
2224

2325
pathspec.gitignore
2426
------------------
@@ -31,6 +33,7 @@ pathspec.gitignore
3133
:show-inheritance:
3234
:special-members: __init__, __eq__, __len__
3335

36+
.. autoclass:: Self
3437

3538
pathspec.backend
3639
----------------

doc/source/conf.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,11 @@
2828
# Add any Sphinx extension module names here, as strings. They can be
2929
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3030
# ones.
31-
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode']
31+
extensions = [
32+
'sphinx.ext.autodoc',
33+
'sphinx.ext.intersphinx',
34+
'sphinx.ext.viewcode',
35+
]
3236

3337
# The autodoc extension doesn't understand the `Self` typehint.
3438
# To avoid documentation build errors, autodoc typehints must be disabled.

pathspec/_meta.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
"Sebastien Eskenazi <https://github.com/SebastienEske>",
6161
"Bar Vered <https://github.com/barv-jfrog>",
6262
"Tzach Shabtay <https://github.com/tzachshabtay>",
63-
"Adam Dangoor <https://github.com/adamtheturtle>"
63+
"Adam Dangoor <https://github.com/adamtheturtle>",
64+
"Marcel Telka <https://github.com/mtelka>",
6465
]
6566
__license__ = "MPL 2.0"

pathspec/gitignore.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040

4141
Self = TypeVar("Self", bound='GitIgnoreSpec')
4242
"""
43-
:class:`GitIgnoreSpec` self type hint to support Python v<3.11 using PEP 673
43+
:class:`.GitIgnoreSpec` self type hint to support Python v<3.11 using PEP 673
4444
recommendation.
4545
"""
4646

pathspec/pathspec.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
Self = TypeVar("Self", bound='PathSpec')
2222
"""
23-
:class:`PathSpec` self type hint to support Python v<3.11 using PEP 673
23+
:class:`.PathSpec` self type hint to support Python v<3.11 using PEP 673
2424
recommendation.
2525
"""
2626

pathspec/pattern.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
RegexPatternSelf = TypeVar("RegexPatternSelf", bound='RegexPattern')
2424
"""
25-
:class:`RegexPattern` self type hint to support Python v<3.11 using PEP 673
25+
:class:`.RegexPattern` self type hint to support Python v<3.11 using PEP 673
2626
recommendation.
2727
"""
2828

0 commit comments

Comments
 (0)