sphinx

sphinx copied to clipboard

Clearly separate TODOs/links in the list of TODOs

1

**Is your feature request related to a problem? Please describe.** The way the TODOs/links are listed in the list of TODOs is confusing. For instance, if you have a quick...

dbitouze

choose a docstring convention

11

ruff can be used to enforce 3 different docstring conventions. options are [google](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings), [numpy](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard), and [pep257](https://peps.python.org/pep-0257/) We should pick one, configure Ruff to lint for it, and fix/whitelist any existing...

danieleades

Add `no_index_entry` config variable, and implement `:no-index-entry:` for autodoc :)

2

Subject: Support use of `:no-index-entry:` at a project-level and within autodoc. ### Feature or Bugfix - Feature ### Purpose I love the `index` directive, and I use it often when...

sneakers-the-rat

Maintenance: consider migration from karma-runner to jasmine-browser-runner.

9

### Describe the bug The Karma browser-based test framework that we use to run tests for the Sphinx JavaScript code that runs in the client browser is [deprecated](https://github.com/karma-runner/karma/commit/450fdfdac5b999967daec1020f1ac69cf9b854ab). We may...

jayaddison

### Describe the bug - [ ] The examples do not include the CRC32 checksums added in #11415 - [ ] There should be a "changed in version 7.1" mentioning...

mgeier

Tests: generate the indexes in the HTML search JavaScript tests using the application code.

2

**Is your feature request related to a problem? Please describe.** We have JavaScript [test coverage of our HTML search functionality](https://github.com/sphinx-doc/sphinx/blob/5695b76f05af253f8eb3a956d25950af81befc7e/tests/js/searchtools.js), and that's great. However: the tests use [inline-declared index datastructures](https://github.com/sphinx-doc/sphinx/blob/5695b76f05af253f8eb3a956d25950af81befc7e/tests/js/searchtools.js#L6-L12)...

jayaddison

MyPy warn unreachable

3

Subject: MyPy warn unreachable ### Feature or Bugfix - Feature ### Purpose - Give it a go, check whether this results in some true positives and not too many false...

DimitriPapadopoulos

Enable async capabilities for HTTP requests

10

**Is your feature request related to a problem? Please describe.** From #6629, the `linkcheck` command is currently using threads to concurrently check the status of links in the documentation. Threads...

francoisfreitag

Allow non-RST parsers to substitute the Locale transform

9

**Describe the bug** https://github.com/sphinx-doc/sphinx/commit/79650f5827e146afe3ff50485f8a4bd6755f895d (#4938) added code that adds a line of hyphens under (for example) an admonition's title's text. However, a line of hyphens is an RST-specific syntax for...

jpmckinney

[FEATURE] Optimization of ``linkcheck`` builder's workers (follow-up #11324)

7

This is a follow-up of https://github.com/sphinx-doc/sphinx/issues/11324#issuecomment-1513701402 to formalize https://github.com/sphinx-doc/sphinx/issues/11324#issuecomment-1511193722 The ``linkcheck`` builder extracts all the links that should be checked, putting them in a queue so that a ``HyperlinkAvailabilityCheckWorker`` can...

picnixz