sphinx
sphinx copied to clipboard
sphinx-doc
The Sphinx documentation generator
Since #10819, index entries are returned as search results. When the query string exactly matches an indexed term, all index entries become search results with score 100. This places them...
New exact phrase searching feature (for HTML)
Fix #11278. Fix #11531. Details: - Add `:classmethod:` directive option for `@classmethod` combined with `@singledispatchmethod`. - Add tests. ~~There is some decision making to doc for this feature concerning the...
Closes #11474. Closes #11908. Note that this fix may increased build time for very large projects since we need to revert back to reading at least twice the pickled files....
Fix #10193. Due to various side-effects, the test suite must currently be executed in its own (see #11285).
### Describe the bug The [`test_connect_to_selfsigned_fails` test case in the `test_build_linkcheck` module](https://github.com/sphinx-doc/sphinx/blob/9a30ca7da1aeffe0c21b81fc7722eb1aed1512da/tests/test_builders/test_build_linkcheck.py#L628-L639) appears to fail occasionally on Windows: ``` ================================== FAILURES =================================== app = @pytest.mark.sphinx('linkcheck', testroot='linkcheck-localserver-https', freshenv=True) def test_connect_to_selfsigned_fails(app): with...
### Describe the bug As-written, the search code for Sphinx appears intended to give a [score of `7`](https://github.com/sphinx-doc/sphinx/blob/574519900ee7eb8b2a1422288139bcc20b56c6d9/sphinx/themes/basic/static/searchtools.js#L43) to [partial-matches](https://github.com/sphinx-doc/sphinx/blob/574519900ee7eb8b2a1422288139bcc20b56c6d9/sphinx/themes/basic/static/searchtools.js#L484-L487) of the user query against document titles. This compares to...
**Is your feature request related to a problem? Please describe.** When using autodoc\_pydantic with recursive autosummary, I must edit the template so that it documents items with objtype `pydantic_model`. The...
### Describe the bug We currently list the same page multiple times if, for example, both the title and content search match it. Since the preview is always the same,...
mypy is currently not run on the tests directory. This PR addresses that. There's a *massive* number of errors- too many to introduce in one PR. Hence I'm whitelisting the...
