sphinx
sphinx copied to clipboard
sphinx-doc
The Sphinx documentation generator
Constructor annotations were not properly detected in autodoc when `autodoc_typehints` was `'description'` or `'both'`. ### Feature or Bugfix - Bugfix ### Relates - https://github.com/sphinx-doc/sphinx/issues/10605
### Describe the bug I've noticed this in 4.3.2 through 5.1.1. Consider something like the following: ``` .. include:: /includes/common/foo.rst :start-after: start-some-key-desc :end-before: end-some-key-desc ``` Lets say that the key...
### Feature or Bugfix - Feature ### Purpose Previously, symbol resolution always stopped at type aliases and also did not consider base classes. For example, with the following document: ```rst...
### Describe the bug With `autodoc_typehints = 'description'`, the parameter type annotations of the constructor (`__init__`) of generic classes are missing from the description. ### How to Reproduce With `autodoc_typehints...
in `sphinx.builders.linkcheck.Hyperlink` there is a field called `lineno` with the type `Optional[int]`. There is another class `sphinx.builders.linkcheck.CheckResult` with the field `lineno` with type `int`. in line 229, a `CheckResult` is...
use mypy to lint the 'tests' folder, as well as the source directory
the typings for `sphinx.application.Sphinx.add_config_value` are a little inconsistent. the type signature is currently ```python def add_config_value(self, name: str, default: Any, rebuild: Union[bool, str], types: Any = ()) -> None: ......
using `follow_imports = skip` is throwing away type information from imports, and therefore hiding errors. This should be changed to `follow_imports = silent` so as to use the type information...
**Is your feature request related to a problem? Please describe.** The new `:recursive:` option for `sphinx.ext.autosummary` is great. I can point Sphinx at the top of my package and have...
It is handy for debugging of search results.
