sphinx
sphinx copied to clipboard
sphinx-doc
The Sphinx documentation generator
### Describe the bug Pytest is failing in tests/test_util_inspect.py with error message about missing `_testcapi` module. Second fail is in `tests/test_ext_math.py::test_imgmath_svg` unit. ### How to Reproduce I'm builing all my...
xref https://github.com/sphinx-doc/sphinx/pull/10562#discussion_r901065801 A
Fixes #10480 This is a larger change, so delaying until 5.2.0 to allow time for review. I also need to update the tests for the new output. ### Feature or...
### Describe the bug On my display I see this  on visiting https://www.sphinx-doc.org/en/master/usage/configuration.html ### How to Reproduce Visit https://www.sphinx-doc.org/en/master/usage/configuration.html with master at least...
### Describe the bug Saying `Foo = NewType(...)` stored `Foo` as `data` and not as `class`. When using `Foo` in a type annotation, `sphinx` searches for it with the `objtypes`...
### Describe the bug Consider the following Python module: File `mymodule/__init__.py`: ``` """ Module mymodule. * Reference to method Base.meth_base: :meth:`mymodule.Base.meth_base`. * Reference to inherited method A.meth_base: :meth:`mymodule.A.meth_base`. - does...
### Context Right now, reStructuredText has fairly basic support for page-level metadata. You supply a key and value, and both are parsed as strings. However, there are many cases where...
### Describe the bug When searching with an exact match of a (sub)title, the result should be shown at the very top. Example: https://www.sphinx-doc.org/en/master/search.html?q=More+topics+to+be+covered As seen the result is shown...
### Context The `singlehtml` builder is a way to combine all pages of the HTML documentation into a single HTML file. This is really useful if you want to quickly...
### Describe the bug The issue is similar to https://github.com/sphinx-doc/sphinx/issues/7868 : some error happens, apparently within the jupyter extension, but the error message does not allow to debug further. I...
