sphinx
sphinx copied to clipboard
sphinx-doc
The Sphinx documentation generator
**Is your feature request related to a problem? Please describe.** During the writing step of the build process, even while using `-j auto`, there are some time-consuming operations that are...
Maybe I'm missing something obvious, but it seems like napoleon unnecessarily depends on autodoc -- i.e., given a standard sphinx directive that documents an object (e.g. one written in an...
If the module import path used by users does not match the directory / file structure, `import_lib`'s `import_module` function cannot find it. Below is a basic example of where this...
### Describe the bug For this issue, the code for the project is found [here](https://github.com/scikit-hep/pyhf/blob/9842e824712fcf02d42e49aa07016ea40139f70c/src/pyhf/tensor/numpy_backend.py) with [conf.py](https://github.com/scikit-hep/pyhf/blob/9842e824712fcf02d42e49aa07016ea40139f70c/docs/conf.py) and documentation rendered [here](https://pyhf--1969.org.readthedocs.build/en/1969/_generated/pyhf.tensor.numpy_backend.numpy_backend.html#pyhf.tensor.numpy_backend.numpy_backend). In the code, we have lines like this for...
**Is your feature request related to a problem? Please describe.** I realised that sometimes interphinx resolves typing.Optional into a link pointing to the docs and sometimes it doesn't. When it...
The heading takes extra space and adds a bit of clutter. Since the only element in the section is the input field we can as well only show the input...
I'm setting up a new web site from scratch and following the latest recommendations for content security policies (CSP). As I move documentation generated by Sphinx, I'm finding all sorts...
Hello, Thank you for working on Sphinx, I used this lib heavily for years. I removed a file during the sphinx run and got the following crash: ```python Traceback (most...
### Describe the bug When citations appear in a parent that has no other siblings besides this single citation, a spurious ```` is generated resulting in invalid html code. It...
### Describe the bug When using `autodoc` to document type aliases in a module, references to those aliases in the signature of a function cannot be resolved, even when using...
