sphinx icon indicating copy to clipboard operation
sphinx copied to clipboard

The Sphinx documentation generator

Results 596 sphinx issues
Sort by recently updated
recently updated
newest added

### Feature or Bugfix - Refactoring ### Purpose Fix and update information ins this page. ### Detail - Documentation needs to mention the new Transifex CLI tool instead of the...

### Describe the bug Building large packages takes a lot of time, most of which is cost on resolving cross-references. When building a package of 70MB and 3399 files ([azure-mgmt-containerservice](https://pypi.org/project/azure-mgmt-containerservice/)),...

extensions:autodoc
type:performance

### Describe the bug In the [Internationalization](https://www.sphinx-doc.org/en/master/usage/advanced/intl.html) page, the [Using Transifex service for team translation](https://www.sphinx-doc.org/en/master/usage/advanced/intl.html#using-transifex-service-for-team-translation) section tells to use the Python-based transifex-client, however it is deprecated. Quoting the info on...

type:bug

### Feature or Bugfix - Refactoring ### Purpose - Add a warning when intersphinx target resolution is ambiguous due to case-insensitivity. - Expands on some [discussion](https://github.com/sphinx-doc/sphinx/pull/12009#discussion_r1504731030) from pull request #12009....

domains:std
extensions:intersphinx

### Describe the bug Sphinx refers to docutils for all `reST` behaviour (except where it extends it), so I would expect that `:loading: embed` would work as documented by docutils...

type:bug
docutils

### Feature or Bugfix - Bugfix ### Purpose When ``toc_object_entries = True`` the nesting of the objects in the toctree seems to done based on the scoping rules of the...

internals:toctree

Hi, I have an website/ebook I'm working on with parts, e.g.: **Part I: Basics** 1. Ch. One 2. Ch. Two **Part II: Intermediate** 3. Ch. Three 4. Ch. Four **Part...

type:enhancement
internals:toctree

### Describe the bug When adding `'literal-block'` to [`gettext_additional_targets` option](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-gettext_additional_targets), parsed-literals are allowed to be translated. However, when they are translated, they are incorrectly rendered. I noticed this while working...

type:bug
i18n

### Feature or Bugfix - Refactoring ### Purpose - Use the more transparent (as in: easier and less ambiguous to understand) `.jinja` suffix for templated files within the Sphinx code...

internals:refactoring
internals:other
priority:low
python

The primary use case here is for within directives (also to a lesser extent roles). Context: To be fair to docutils, it never actually exposes directives as an extension point...