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

**Is your feature request related to a problem? Please describe.** - Use Case: - conf.py: Add a jquery static js asset with `app.app_javascript()` - https://releases.jquery.com/ suggests this `` tag with...

type:proposal

### Describe the bug It seems like the `text` builder can't handle all of the same tables that the html builder can. It is apparently possible for `Table.colwidth` elements to...

type:bug
help wanted
builder:text

### Describe the bug When generating documentation for class with decorators that override __new__, documentation for the class is missing and sphinx warns that maximum recursion depth was exceeded in...

type:bug
extensions:autodoc

### Describe the bug I use sphinx.ext.graphviz with the option: ``` graphviz_output_format = "svg" ``` to include svg files into my documentation. In my source files I use: ```rst .....

type:bug
extensions:graphviz

it is not totally obvious which methods and types in sphinx are part of the public interface. This makes accidental breaking changes very likely. I propose the following convention for...

type:proposal

### Describe the bug When generating documentation for class with decorators, Sphinx recognizes the wrapped class as the wrapper function returned by the top decorator instead of the actual class...

type:bug
extensions:autodoc

Subject: Create autosummary template variables dynamically based on `objtype` from documenters, enabling custom object types like `pydantic_model` to be selectable in templates (https://github.com/sphinx-doc/sphinx/issues/12021, https://github.com/mansenfranzen/autodoc_pydantic/issues/33). ### Feature or Bugfix - [x]...

type:proposal
extensions:autosummary

When creating sphinx extensions (or looking at existing ones), it is always a source of annoyance/confusion trying to remember what callback events are available, what their purpose is, and also...

Rather than having singular `nocolor` and `coloron` functions (left for back-compatibility, introduce a `colorize_output` context manager, for temporarily enabling / disabling colorized output streams, on entering, then return to the...

api:cmdline
type:proposal
internals:refactoring
python

This PR add a new builder `references`, to build a single `references.json`, which provides a mapping for almost* all targets available to reference in the project, including: 1. Internal domain...

builder