summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* A happy new year!Takeshi KOMIYA2022-01-011-1/+1
|
* doc: Update explanation of autodoc_unqualified_typehints (ref: #9931)Takeshi KOMIYA2021-12-181-2/+2
|
* Merge pull request #9963 from tk0miya/refactor_docTakeshi KOMIYA2021-12-166-16/+16
|\ | | | | doc: Use "console" for the highlight language of console output
| * doc: Use "console" for the highlight language of console outputTakeshi KOMIYA2021-12-136-16/+16
| | | | | | | | | | Using "console" language is better for the console example (including command-line prompt)
* | Merge pull request #9287 from ssbarnea/fix/ircTakeshi KOMIYA2021-12-162-2/+2
|\ \ | |/ |/| Document new irc channel location
| * Document new irc channel locationSorin Sbarnea2021-06-012-2/+2
| |
* | Fix #9108: docs: Use default pygments_theme to get accessiblityTakeshi KOMIYA2021-12-111-1/+1
| | | | | | | | | | | | To increse accessiblity of our docs, this changes the pygments_theme of sphinx-docs.org to "default". It was updated to meet WCAG AA in https://github.com/pygments/pygments/pull/1940.
* | Merge pull request #9931 from tk0miya/9075_autodoc_unqualified_typehintsTakeshi KOMIYA2021-12-111-0/+7
|\ \ | | | | | | Close #9075: autodoc: Add a config variable autodoc_unqualified_typehints
| * | Close #9075: autodoc: Add a config variable autodoc_unqualified_typehintsTakeshi KOMIYA2021-12-031-0/+7
| | | | | | | | | | | | | | | | | | If autodoc_unqualified_typehints feature enabled, autodoc suppresses the leading module names of typehints of function signatures (ex. `io.StringIO` -> `StringIO`)
* | | Merge branch '4.x' into texinfo-add-texinfo_emit_document_referencesTakeshi KOMIYA2021-12-1110-15/+381
|\ \ \
| * | | linkcheck: Exclude links from matched documentsChristian Roth2021-12-081-0/+13
| | | |
| * | | doc: Improve autodoc extension exampleJouke Witteveen2021-12-061-5/+4
| | | | | | | | | | | | Enumerations can have aliases, which should be documented as well.
| * | | Merge pull request #9852 from astrojuanlu/new-tutorial-deployingTakeshi KOMIYA2021-12-043-0/+281
| |\ \ \ | | | | | | | | | | New Sphinx tutorial, part IV
| | * | | Remove note to simplify messageJuan Luis Cano Rodríguez2021-11-281-9/+0
| | | | |
| | * | | Add note about `.nojekyll` fileJuan Luis Cano Rodríguez2021-11-231-0/+9
| | | | |
| | * | | Document GitLab PagesJuan Luis Cano Rodríguez2021-11-181-0/+47
| | | | |
| | * | | Add missing content on dependenciesJuan Luis Cano Rodríguez2021-11-181-7/+12
| | | | |
| | * | | Describe deployment on Read the Docs and GitHub PagesJuan Luis Cano Rodríguez2021-11-182-0/+74
| | | | |
| | * | | Write how to publish documentation sourcesJuan Luis Cano Rodríguez2021-11-181-0/+76
| | | | |
| | * | | Change focus to be broader and more descriptiveJuan Luis Cano Rodríguez2021-11-181-5/+2
| | | | |
| | * | | Finish background section on deploymentJuan Luis Cano Rodríguez2021-11-171-0/+24
| | | | |
| | * | | Add descriptive section to deployment section of tutorialJuan Luis Cano Rodríguez2021-11-172-0/+58
| | | | |
| * | | | doc: Fix autodoc extension exampleJouke Witteveen2021-12-021-2/+5
| | |/ / | |/| | | | | | | | | | | | | | | | | | `directivetype` is set to mimic `ClassDocumenter`. Reflect that. `isinstance` would work on the enum members, but that is not what we want here. `issubclass` raises a TypeError when called on objects that are not classes.
| * | | Merge pull request #9800 from hoefling/extlinks/replacements-checkTakeshi KOMIYA2021-11-291-3/+1
| |\ \ \ | | | | | | | | | | Proposal: check if hardcoded URLs can be replaced with extlinks
| | * | | replace hardcoded refs in docs with extlinksoleg.hoefling2021-11-121-3/+1
| | | | | | | | | | | | | | | | | | | | Signed-off-by: oleg.hoefling <oleg.hoefling@gmail.com>
| * | | | Merge pull request #9831 from Yoshanuikabundi/autosummary___all__Takeshi KOMIYA2021-11-262-0/+23
| |\ \ \ \ | | | | | | | | | | | | Allow autosummary to respect __all__
| | * | | | Corrections from review by tk0miyaJosh Mitchell2021-11-152-7/+11
| | | | | |
| | * | | | #2021: Allow autosummary to respect __all__Josh Mitchell2021-11-151-0/+19
| | |/ / /
| * | | | Merge branch '4.3.x' into 4.xTakeshi KOMIYA2021-11-231-0/+5
| |\ \ \ \
| | * | | | Fix #9864: mathjax: Failed to render equations via MathJax v2Takeshi KOMIYA2021-11-211-0/+5
| | |/ / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | MathJax library has been loaded via "defer" method since v4.3.0. But it prevents to work MathJax v2. This rollbacks the change and use "async" method as default again. To support changing the loading method, this allows to specify it via mathjax_options.
| * | | | Merge pull request #9850 from astrojuanlu/new-tutorial-describing-code-otherTakeshi KOMIYA2021-11-221-3/+47
| |\ \ \ \ | | |_|/ / | |/| | | Add brief section on documenting other languages to tutorial
| | * | | Apply suggestions from code reviewJuan Luis Cano Rodríguez2021-11-181-4/+6
| | | | | | | | | | | | | | | Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>
| | * | | Remove reference to unmaintained extensionJuan Luis Cano Rodríguez2021-11-151-2/+1
| | | | |
| | * | | TypoJuan Luis Cano Rodríguez2021-11-151-1/+1
| | | | | | | | | | | | | | | Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
| | * | | Add clarification on other languagesJuan Luis Cano Rodríguez2021-11-151-3/+46
| | |/ /
| * | | 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/
* | | texinfo: simplify reference emission.Martin Liska2021-11-123-0/+15
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | The commit adds a new config value 'texinfo_emit_document_references' that blocks the emission of inline references and make it better readable with legacy stand-alone reader ``info``. Before the change we emit: Default option value for @ref{e,,-Wshift-overflow3}. while with texinfo_emit_document_references == True: Default option value for -Wshift-overflow3. It addresses limitations mentioned in Sphinx' FAQ: https://www.sphinx-doc.org/en/master/faq.html#texinfo-info
* | 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
View Lorry Controller Status