Skip to content

Commit 29bc027

Browse files
amotljonathanslenders
authored andcommitted
Documentation: Modernize versions of Sphinx and friends
1 parent aa5d0d7 commit 29bc027

File tree

3 files changed

+15
-4
lines changed

3 files changed

+15
-4
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,6 @@ docs/_build
4444

4545
# pycharm metadata
4646
.idea
47+
48+
# virtualenvs
49+
.venv*

docs/conf.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,14 @@
9292
# If true, keep warnings as "system message" paragraphs in the built documents.
9393
# keep_warnings = False
9494

95+
# autodoc configuration
96+
# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
97+
autodoc_inherit_docstrings = False
98+
autodoc_mock_imports = [
99+
"prompt_toolkit.eventloop.win32",
100+
"prompt_toolkit.input.win32",
101+
"prompt_toolkit.output.win32",
102+
]
95103

96104
# -- Options for HTML output ----------------------------------------------
97105

docs/requirements.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Sphinx==4.1.2
2-
wcwidth==0.2.5
3-
pyperclip==1.8.2
4-
sphinx_rtd_theme==0.5.2
1+
Sphinx<7
2+
wcwidth<1
3+
pyperclip<2
4+
sphinx_rtd_theme<2

0 commit comments

Comments
 (0)