|
12 | 12 | for those who like elaborate docstrings.
|
13 | 13 |
|
14 | 14 | This module is currently based on :mod:`sphinx.ext.autodoc` from Sphinx version
|
15 |
| -7.2.6. Compare against the upstream original source file |
| 15 | +7.2.6. Compare (do diff) with the upstream source file |
16 | 16 | `sphinx/ext/autodoc/__init__.py
|
17 | 17 | <https://github.com/sphinx-doc/sphinx/blob/v7.2.6/sphinx/ext/autodoc/__init__.py>`_.
|
18 | 18 |
|
@@ -223,8 +223,21 @@ def cut_lines(pre: int, post: int = 0, what: str | None = None) -> Callable:
|
223 | 223 | from sphinx.ext.autodoc import cut_lines
|
224 | 224 | app.connect('autodoc-process-docstring', cut_lines(4, what=['module']))
|
225 | 225 |
|
226 |
| - This can (and should) be used in place of :confval:`automodule_skip_lines`. |
| 226 | + This can (and should) be used in place of ``automodule_skip_lines``. |
227 | 227 | """
|
| 228 | + # ------------------------------------------------------------------------- |
| 229 | + # Sphinx in Sage does not use 'sphinx_toolbox.confval' extension, and hence |
| 230 | + # does not know the role ":confval:". Use of the role in this module |
| 231 | + # results in failure of building the reference manual. |
| 232 | + # |
| 233 | + # In the above docstring, |
| 234 | + # |
| 235 | + # ... in place of :confval:`automodule_skip_lines`. |
| 236 | + # |
| 237 | + # was changed to |
| 238 | + # |
| 239 | + # ... in place of ``automodule_skip_lines``. |
| 240 | + # ------------------------------------------------------------------------- |
228 | 241 | def process(app: Sphinx, what_: str, name: str, obj: Any, options: Any, lines: list[str],
|
229 | 242 | ) -> None:
|
230 | 243 | if what and what_ not in what:
|
|
0 commit comments