sphinx
sphinx copied to clipboard
sphinx-doc
The Sphinx documentation generator
**Describe the bug** If I document a class X with a method y() on it, when autodoc-skip-member is called for the method y() the value of what="class" and name="y". The...
Collect all titles from all pages and utilize a full match (case insensitive) in Search page. Fixes: #10689
### Describe the bug Trying to build my sphinx documentation for my company project (can t share code...) When running it raise this log: ``` # Sphinx version: 5.1.1 #...
### Describe the bug I deployed Jupyter-book on Netlify with `.md` and `.ipynb` files. But there are warnings for all `{tableofcontents}` markdown files. For example, - [S1D00-getting-started.md](https://github.com/kevin7lou/Statistics-and-Data-Analysis-in-Python/blob/master/doc/Python-for-Data-Analysis/S1D00-getting-started.md?plain=1) has `{tableofcontents}`. -...
### Describe the bug The [bugs fixed](https://www.sphinx-doc.org/en/master/changes.html#id35) section of the 5.1.0 Changelog includes this line: * [#10031](https://github.com/sphinx-doc/sphinx/issues/10031): py domain: Fix spurious whitespace in unparsing various operators (+, -, ~, and...
Subject: ### Feature or Bugfix - Bugfix ### Purpose This improves the display of the sidebar of the agogo theme ### Relates #10715
Sphinx should support NumPy style Python return docs with one or more named variables. For example, see the example below from the following link: https://numpydoc.readthedocs.io/en/latest/format.html#returns ``` Returns ------- err_code :...
Subject: linkcheck: Check the source URL of raw directives ### Feature or Bugfix - Feature ### Purpose The source URL of `raw` directives that use the `url` option is now...
**Is your feature request related to a problem? Please describe.** When using a [`raw` directive](https://docutils.sourceforge.io/docs/ref/rst/directives.html#raw-data-pass-through) with the `url` option, the `linkcheck` builder does not check this URL. **Describe the solution...
Subject: Labels for images with :only: directive ### Problem Hello, I would like to add a label to an image with only directive. I'm trying different combinations but I still...
