summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* | | | | | | | | | | | | | | | | | | | | | | | | | | | Update RFC base urlMatt Ficke2021-11-161-2/+2
|/ / / / / / / / / / / / / / / / / / / / / / / / / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The tools.ietf.org subdomain is being wound down and services are moving to datatracker.ietf.org. Links to RFC documents using the old subdomain are being redirected to datatracker; this updates the configured `rfc_base_url` to point to the current subdomain. Discussion: https://mailarchive.ietf.org/arch/msg/ietf/0n-6EXEmkTp3Uv_vj-5Vnm3o0bo/
* | | | | | | | | | | | | | | | | | | | | | | | | | | Merge pull request #9628 from ↵Takeshi KOMIYA2021-11-101-0/+6
|\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | tk0miya/9623_suppress_warnings_for_excluded_document_in_toctree Close #9623: Allow to suppress warnings on excluded document found in toctree
| * \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Merge branch '4.x' into 9623_suppress_warnings_for_excluded_document_in_toctreeTakeshi KOMIYA2021-11-1023-24/+576
| |\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ | | | |_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|/ / | | |/| | | | | | | | | | | | | | | | | | | | | | | | |
| * | | | | | | | | | | | | | | | | | | | | | | | | | | Fix #9623: Separate warning type 'toc.not_readable' to 'toc.excluded'Takeshi KOMIYA2021-11-101-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | |
| * | | | | | | | | | | | | | | | | | | | | | | | | | | Close #9623: Allow to suppress warnings on excluded document found in toctreeTakeshi KOMIYA2021-09-121-0/+1
| | |_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|/ / / / / / | |/| | | | | | | | | | | | | | | | | | | | | | | | |
* | | | | | | | | | | | | | | | | | | | | | | | | | | Close #9618: i18n: Add gettext_allow_fuzzy_translationsTakeshi KOMIYA2021-11-101-0/+7
| |/ / / / / / / / / / / / / / / / / / / / / / / / / |/| | | | | | | | | | | | | | | | | | | | | | | | |
* | | | | | | | | | | | | | | | | | | | | | | | | | Document responsiveness of themesMartin Fischer2021-11-031-0/+4
| |_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|/ / |/| | | | | | | | | | | | | | | | | | | | | | | |
* | | | | | | | | | | | | | | | | | | | | | | | | rename intersphinx_disabled_{refs -> reftypes}Jakob Lykke Andersen2021-10-311-6/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | And change format for domains to {name}:*
* | | | | | | | | | | | | | | | | | | | | | | | | intersphinx_disabled_refs, doc default valueJakob Lykke Andersen2021-10-311-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | |
* | | | | | | | | | | | | | | | | | | | | | | | | intersphinx_disabled_refs, rename 'all' to '*'Jakob Lykke Andersen2021-10-311-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | |
* | | | | | | | | | | | | | | | | | | | | | | | | Generalize to disable specific refs as well.Jakob Lykke Andersen2021-10-311-12/+19
| | | | | | | | | | | | | | | | | | | | | | | | |
* | | | | | | | | | | | | | | | | | | | | | | | | Fix typoJakob Lykke Andersen2021-10-311-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | |
* | | | | | | | | | | | | | | | | | | | | | | | | Add intersphinx_disabled_domainsJakob Lykke Andersen2021-10-311-0/+19
| |_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|/ / |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Fixes sphinx-doc/sphinx#2068 Replaces sphinx-doc/sphinx#8981
* | | | | | | | | | | | | | | | | | | | | | | | Update Chocolatey Install LinkDrew Mares2021-10-271-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The install URL returned a 404 but now it is updated to the new location
* | | | | | | | | | | | | | | | | | | | | | | | Merge pull request #9769 from francoisfreitag/fix-linkcheck-auth-linkTakeshi KOMIYA2021-10-271-4/+2
|\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Fix linkcheck_auth link to Requests authentication
| * | | | | | | | | | | | | | | | | | | | | | | | Fix linkcheck_auth link to Requests authenticationFrançois Freitag2021-10-251-4/+2
| | |_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|/ / | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The link was directing to https://www.sphinx-doc.org/en/master/usage/requests-auth>. Prefer using the intersphinx module to generate the link, it’s more robust than directly linking to the page.
* | | | | | | | | | | | | | | | | | | | | | | | Fix #9752: autodoc: Failed to detect type annotation for slots attributeTakeshi KOMIYA2021-10-231-0/+5
|/ / / / / / / / / / / / / / / / / / / / / / /
* | | | | | | | | | | | | | | | | | | | | | | Add missing space in intersphinx docGabe R2021-10-191-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | There was a space missing between `-m` and `sphinx.ext.intersphinx` in the example of showing all mappings in a intersphinx file. I added it in.
* | | | | | | | | | | | | | | | | | | | | | | Fix #9710: html: Wrong styles for even/odd rows in nested tablesTakeshi KOMIYA2021-10-091-0/+20
| | | | | | | | | | | | | | | | | | | | | | |
* | | | | | | | | | | | | | | | | | | | | | | Merge pull request #9679 from latosha-maltba/doc/directive-indentTakeshi KOMIYA2021-10-091-1/+21
|\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Document indent behaviour for directives
| * | | | | | | | | | | | | | | | | | | | | | | Document indent behaviour for directivesLatosha Maltba2021-09-271-1/+21
| | |_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Mention how the indent of the contents for directives is chosen and what the effect on directives which are sensitive to whitespace is, e.g. code-block.
* | | | | | | | | | | | | | | | | | | | | | | Merge branch '4.x' into 9683_add_css_fileTakeshi KOMIYA2021-10-0914-4/+419
|\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ | | |_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|/ | |/| | | | | | | | | | | | | | | | | | | | |
| * | | | | | | | | | | | | | | | | | | | | | Merge pull request #9534 from astrojuanlu/new-tutorial-describing-codeTakeshi KOMIYA2021-10-0912-3/+413
| |\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | New Sphinx tutorial, part III
| | * | | | | | | | | | | | | | | | | | | | | | Explain that there are several domainsJuan Luis Cano Rodríguez2021-09-131-0/+7
| | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | Get function signature right since the beginningJuan Luis Cano Rodríguez2021-09-132-4/+3
| | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | Fix line widthJuan Luis Cano Rodríguez2021-09-131-2/+2
| | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | Use stable Sphinx versionJuan Luis Cano Rodríguez2021-09-131-1/+1
| | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | Amend explanation on the default-domain directiveJuan Luis Cano Rodríguez2021-09-131-2/+3
| | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | Point readers to info field lists insteadJuan Luis Cano Rodríguez2021-09-131-1/+1
| | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | Remove square bracketsJuan Luis Cano Rodríguez2021-09-133-4/+2
| | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | Improve text of some linksJuan Luis Cano Rodríguez2021-09-132-3/+2
| | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | TypoJuan Luis Cano Rodríguez2021-09-131-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Co-authored-by: Takeshi KOMIYA <i.tkomiya@gmail.com>
| | * | | | | | | | | | | | | | | | | | | | | | Insist that automatic is betterJuan Luis Cano Rodríguez2021-09-131-0/+1
| | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | Highlight only function docstringJuan Luis Cano Rodríguez2021-09-131-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
| | * | | | | | | | | | | | | | | | | | | | | | Style improvementsJuan Luis Cano Rodríguez2021-09-131-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
| | * | | | | | | | | | | | | | | | | | | | | | Add reference to tutorial TOCJuan Luis Cano Rodríguez2021-09-061-3/+3
| | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | Add connections to the next sectionsJuan Luis Cano Rodríguez2021-09-065-1/+13
| | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | Simplify installationJuan Luis Cano Rodríguez2021-09-062-61/+15
| | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | Include explanation about doctestsJuan Luis Cano Rodríguez2021-09-061-0/+5
| | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | Simplify doctest sectionJuan Luis Cano Rodríguez2021-09-061-59/+7
| | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | Be more explicit on automatic xref generationJuan Luis Cano Rodríguez2021-09-061-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
| | * | | | | | | | | | | | | | | | | | | | | | Reword primary domainsJuan Luis Cano Rodríguez2021-09-061-3/+6
| | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | Rephrase explanation on square bracketsJuan Luis Cano Rodríguez2021-09-061-2/+2
| | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | Style improvementJuan Luis Cano Rodríguez2021-09-061-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
| | * | | | | | | | | | | | | | | | | | | | | | Add section on autosummaryJuan Luis Cano Rodríguez2021-08-123-0/+79
| | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | Add section on automatic documentation generationJuan Luis Cano Rodríguez2021-08-123-0/+91
| | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | Add section on doctestsJuan Luis Cano Rodríguez2021-08-121-0/+124
| | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | Add section on Python code preparationJuan Luis Cano Rodríguez2021-08-122-0/+73
| | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | Add tutorial section on documenting Python objectsJuan Luis Cano Rodríguez2021-08-125-0/+115
| | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | Add cross reference to role definitionsJuan Luis Cano Rodríguez2021-08-121-2/+3
| | | |_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|/ / / | | |/| | | | | | | | | | | | | | | | | | | |