summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Merge branch '3.x'Takeshi KOMIYA2020-11-052-3/+12
|\
| * Merge pull request #8359 from sphinx-doc/8349_sphinx-contribTakeshi KOMIYA2020-11-031-3/+3
| |\ | | | | | | doc: Update sphinx-contrib repos' URL (refs: #8349)
| | * doc: Update sphinx-contrib repos' URL (refs: #8349)8349_sphinx-contribTakeshi KOMIYA2020-11-031-3/+3
| | |
| * | Fix #6914: Emit a detailed warning when failed to resolve :ref:Takeshi KOMIYA2020-11-031-0/+9
| |/ | | | | | | | | | | | | | | | | To be clear the ambiguous warning for missing-reference :ref:, this separates the warning to missing-label and missing-caption. To emit a warning dynamically, this also adds a new event: `warn-missing-reference` to customize warning messages via event handlers.
* | Merge pull request #8284 from tk0miya/7996_man_make_section_directory_by_defaultTakeshi KOMIYA2020-10-281-1/+3
|\ \ | | | | | | Close #7996: manpage: Make a section directory on build manpage by default
| * | Close #7996: manpage: Make a section directory on build manpage by defaultTakeshi KOMIYA2020-10-281-1/+3
| | |
* | | Merge branch '3.x' into masterTakeshi KOMIYA2020-10-285-2/+20
|\ \ \ | |/ / |/| / | |/
| * Fix #8298: sphinx-quickstart: Add :option:`sphinx-quickstart --no-sep` optionTakeshi KOMIYA2020-10-261-0/+4
| |
| * Merge pull request #8334 from mgeier/doc-faviconTakeshi KOMIYA2020-10-252-0/+9
| |\ | | | | | | DOC: Add favicon
| | * DOC: Add faviconMatthias Geier2020-10-242-0/+9
| | |
| * | Fix docs type: "the builder builders" → "builders"Jon Dufresne2020-10-241-2/+2
| |/
| * Merge pull request #8289 from graingert/allow-to-suppress-duplicated-tocTakeshi KOMIYA2020-10-241-0/+5
| |\ | | | | | | Allow to suppress "duplicated toc entry" warnings from epub builder
| | * Apply suggestions from code reviewThomas Grainger2020-10-051-1/+0
| | |
| | * Fix #8289: Allow to suppress "duplicated ToC entry found" warnings from epub ↵Thomas Grainger2020-10-051-0/+6
| | | | | | | | | | | | builder
* | | Merge pull request #8324 from pradyunsg/patch-1Takeshi KOMIYA2020-10-241-31/+8
|\ \ \ | | | | | | | | Documentation: Reword section on Third Party Themes
| * | | Reword section on Third Party ThemesPradyun Gedam2020-10-211-31/+8
| | | | | | | | | | | | | | | | | | | | - No longer attempt to be the location for listing themes -- only Sphinx-RTD-Theme was listed here. - Mention the classifier used when searching on PyPI. - Emphasize sphinx-themes.org as a gallery of themes.
* | | | Merge branch '3.x'Takeshi KOMIYA2020-10-241-2/+0
|\ \ \ \ | |/ / / |/| / / | |/ /
| * | Outdated comment in docs config for intersphinxFrançois Freitag2020-10-051-2/+0
| |/ | | | | | | Intersphinx is in use since 6a396c7eb85e4f2e2291652c454352bad1a397f4.
* | Merge branch '3.x' into masterTakeshi KOMIYA2020-10-047-5/+59
|\ \ | |/
| * Merge pull request #8273 from sphinx-doc/7996_man_make_section_directoryTakeshi KOMIYA2020-10-041-0/+6
| |\ | | | | | | Close #7996: manpage: Add man_make_section_directory
| | * Close #7996: manpage: Add man_make_section_directory7996_man_make_section_directoryTakeshi KOMIYA2020-10-031-0/+6
| | | | | | | | | | | | | | | | | | Add a new config variable; man_make_section_directory to make a section directory on build man page. During 3.x, it defaults to False and will be changed to True on 4.0 release.
| * | autodoc: deprecate SingledispatchFunctionDocumenterTakeshi KOMIYA2020-10-041-0/+10
| |/ | | | | | | | | | | In #7487, SingledispatchFunctionDocumenter is merged into FunctionDocumenter. SingledispatchMethodDocumenter is also. As a result, They are no longer needed. So this deprecates them.
| * Strip trailing whitespaces and normalize line endingsFrançois Freitag2020-10-034-5/+5
| | | | | | | | | | | | | | | | Trailing whitespace do not have impact on the result, they are just unused bytes. Most text editors are configured to strip trailing whitespaces. Remove them all in one go. Update a handful of files to use the UNIX line ending.
| * Close #6518: autodoc: Add autodoc_type_aliasesTakeshi KOMIYA2020-10-031-0/+38
| | | | | | | | | | autodoc_type_aliases allows to keep user defined type alises not evaluated in the generated document.
* | Merge branch '3.x' into masterTakeshi KOMIYA2020-10-033-1/+23
|\ \ | |/
| * Fix typo: anchestor -> ancestor.Bradley Dice2020-09-201-1/+1
| |
| * Close #8081: latex: Allow to add LaTeX package until writing tex fileTakeshi KOMIYA2020-09-211-0/+10
| | | | | | | | | | | | | | This postpones the evaluation of LaTeX packages via ``app.add_latex_package()`` to just before writing .tex file. That allows extensions to add LaTeX packages during reading and resolving phase.
| * C, recursive alias declarationsJakob Lykke Andersen2020-09-131-0/+12
| | | | | | | | Fixes sphinx-doc/sphinx#8141
* | Update link to sphinxcontrib on GitHubSteve Piercy2020-09-261-1/+1
| |
* | Add "Getting Started as a Translator"Tetsuo Koyama2020-09-201-0/+2
| |
* | :pencil2: Fix grammerTetsuo Koyama2020-09-201-1/+1
| |
* | Merge branch '3.x' into masterTakeshi KOMIYA2020-09-134-13/+18
|\ \ | |/
| * Fix some broken linksPatrick Decat2020-09-031-5/+5
| |
| * Fixes minor typo in quickstart.rstFalko Axmann2020-08-301-1/+1
| |
| * Merge pull request #8140 from chrisjsewell/docs/execution-processTakeshi KOMIYA2020-08-221-7/+8
| |\ | | | | | | 📚 DOCS: Improve build process overview
| | * Correct numbersChris Sewell2020-08-211-6/+5
| | |
| | * 📚 DOCS: Improve build process overviewChris Sewell2020-08-201-1/+3
| | |
| * | Add rubric in Getting helpYves Chevallier2020-08-151-0/+4
| | |
* | | Merge branch '3.x'Takeshi KOMIYA2020-08-141-0/+6
|\ \ \ | |/ /
| * | Merge pull request #8058 from nijel/single-domainTakeshi KOMIYA2020-08-141-0/+6
| |\ \ | | | | | | | | i18n: Add support for having single text domain
| | * | i18n: Add support for having single text domainMichal Čihař2020-08-071-0/+6
| | |/ | | | | | | | | | | | | | | | | | | The gettext_compact can now be a string which is then a single domain for all documents. Fixes #784
* | | sphinx.ext.autodoc: fix typo in docsAdam J. Stewart2020-08-111-1/+1
| | |
* | | Merge branch '3.x'Takeshi KOMIYA2020-08-0812-21/+78
|\ \ \ | |/ /
| * | Add link to third party themes on GitLabMatt from Documatt2020-08-071-1/+2
| |/ | | | | | | GitLab, alternative to GitHub, also contains a lot of beautiful open source themes.
| * Merge pull request #8047 from cjmayo/typosTakeshi KOMIYA2020-08-068-16/+29
| |\ | | | | | | Assorted typos including sphinx-buid in internationalization figure
| | * Fix typo sphinx-buid in internationalization figureChris Mayo2020-08-033-7/+20
| | |
| | * Fix typos in the documentationChris Mayo2020-08-035-9/+9
| | |
| * | Close #6698: doctest: Add :no-trim-doctest-flags: optionsTakeshi KOMIYA2020-08-051-3/+18
| |/ | | | | | | | | | | | | To control trimming doctest flags manually, this adds new options :trim-doctest-flags: and :no-trim-doctest-flags: to doctest directives. It helps to describes doctest module itself in python doc (see #6698).
| * refactor: autodoc: Add `EMPTY` that matches to no membersTakeshi KOMIYA2020-08-031-0/+5
| | | | | | | | | | Add a special class `_Empty` to make the comparison of :exclude-members: option simply. It never matches to any members.
| * Merge pull request #8035 from tk0miya/8034_argument_for_private-membersTakeshi KOMIYA2020-08-032-1/+19
| |\ | | | | | | Close #8034: autodoc: :private-member: can take an list of member names
View Lorry Controller Status