sphinx
sphinx copied to clipboard
The Sphinx documentation generator
## Background One of the challenges in getting started with Sphinx is the `conf.py` file, for a few reasons: 1. It is written in Python, and so it is Python-specific,...
Subject: Enable MyPy error codes ### Feature or Bugfix - Feature ### Purpose Enable MyPy error codes as suggested by [Repo-Review](https://learn.scientific-python.org/development/guides/repo-review/?repo=sphinx-doc%2Fsphinx&branch=master). ### Detail * [MY104](https://learn.scientific-python.org/development/guides/style#MY104): MyPy enables ignore-without-code Must have...
Subject: Enable parallel post transformations including `doctree-resolved` **and** `write_doc_serialized`. This is an extended version of PR https://github.com/sphinx-doc/sphinx/pull/11733. It has basically the same purpose. Sorry for opening a second PR, however...
This is a proof of concept to fix https://github.com/sphinx-doc/sphinx/issues/8852 based on my idea : https://github.com/sphinx-doc/sphinx/issues/8852#issuecomment-1892862321 > [!WARNING] > BREAKING CHANGE: The new `parse_inline()` function must now be implemented by third-party...
### Describe the bug Hello, Sphinx Maintainance Team. Recently, I tried to translate CMake Documentation with its .po files generated by Gettext builder. In CMake Documentation, we can see that...
### Feature or Bugfix - Bugfix ### Purpose Clean output ### Detail ### Relates https://discuss.python.org/t/leading-whitespaces-on-sphinx-build-output/53308
### Feature or Bugfix - Bugfix ### Purpose There is no – character entitiy in xhtml. The epubcheck reports fatal error and epub readers like Books.app crashes. ### Detail ###...
**Is your feature request related to a problem? Please describe.** As a docs reader, I want to read the *source* in the viewcode interface and then open it in {Github,...
### Describe the bug `autodoc_class_signature = "separated"` option will cause class without `__init__` raise a warning and can't build with `-W`  ### How to Reproduce use this repo: https://github.com/trim21/sphinx-autodoc_class_signature-bug...
**Is your feature request related to a problem? Please describe.** I'd like to label and refer to individual lines inside math directives. **Describe the solution you'd like** Something like a...