summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* 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
* | Outdated comment in docs config for intersphinxFrançois Freitag2020-10-051-2/+0
|/ | | | Intersphinx is in use since 6a396c7eb85e4f2e2291652c454352bad1a397f4.
* 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.
* 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
* 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 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
* | 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
| * Close #8034: autodoc: :private-member: can take an list of member namesTakeshi KOMIYA2020-08-022-1/+19
| | | | | | | | | | Now :private-member: option can take an explicit list of member names to be documented as its arguments (like :special-members: does).
* | Close #7768: i18n: figure_language_filename supports {docpath} tokenTakeshi KOMIYA2020-08-021-0/+5
|/ | | | | | To build structured i18n imaging directory, figure_language_filename now supports `{docpath}` token that is a dirname of the current document.
* Merge branch '3.x' into 7993_texinfo_for_nested_descTakeshi KOMIYA2020-08-0113-223/+560
|\
| * moving extension dev overviewChris Holdgraf2020-07-293-4/+1
| |
| * commentsChris Holdgraf2020-07-292-5/+22
| |
| * rearranging a few docs and small updatesChris Holdgraf2020-07-296-24/+46
| |
| * Update doc/development/tutorials/builders.rstChris Holdgraf2020-07-291-1/+1
| |
| * flake8Chris Holdgraf2020-07-292-4/+5
| |
| * several documentation improvements to theming, templating, and extension ↵Chris Holdgraf2020-07-298-64/+290
| | | | | | | | development
| * Merge pull request #7997 from sphinx-doc/fix/6863Takeshi KOMIYA2020-07-251-3/+37
| |\ | | | | | | fix 6863: add description literalinclude option (start/end have same string)
| | * fix 6863: add description literalinclude option (start/end have same string)Yoshiki Shibukawa2020-07-251-3/+37
| | |
| * | Update CHANGES for PR #7690Takeshi KOMIYA2020-07-251-0/+2
| | |
| * | Merge pull request #7690 from keewis/transform_numpy_parameter_typesTakeshi KOMIYA2020-07-251-2/+31
| |\ \ | | | | | | | | preprocessing numpy types
| | * | add a section about napoleon_type_aliases to the documentationKeewis2020-07-251-1/+30
| | | |
| | * | update the link to the official docstring guideKeewis2020-07-251-1/+1
| | |/
| * | Merge pull request #7927 from jnothman/name-case-clashTakeshi KOMIYA2020-07-241-0/+9
| |\ \ | | |/ | |/| Add autosummary_filename_map config to avoid clashes
| | * Add autosummary_filename_map config to avoid clashesJoel Nothman2020-07-081-0/+9
| | |
* | | Fix #7993: texinfo: TypeError is raised for nested object descriptionsTakeshi KOMIYA2020-07-251-0/+5
|/ / | | | | | | | | | | The texinfo writer remembers the current desc node to render a desc_annotation node. This makes the mechanism robust to support nested object descriptions.
* | Add docs and CHANGES for C changesJakob Lykke Andersen2020-07-141-0/+17
| |
View Lorry Controller Status