summaryrefslogtreecommitdiff
path: root/doc/usage
Commit message (Collapse)AuthorAgeFilesLines
* 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
* 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.
* Strip trailing whitespaces and normalize line endingsFrançois Freitag2020-10-033-4/+4
| | | | | | | | 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
|
* C, recursive alias declarationsJakob Lykke Andersen2020-09-131-0/+12
| | | | Fixes sphinx-doc/sphinx#8141
* Fixes minor typo in quickstart.rstFalko Axmann2020-08-301-1/+1
|
* 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-063-7/+7
|\ | | | | Assorted typos including sphinx-buid in internationalization figure
| * Fix typos in the documentationChris Mayo2020-08-033-7/+7
| |
* | 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).
* Merge pull request #8035 from tk0miya/8034_argument_for_private-membersTakeshi KOMIYA2020-08-031-1/+14
|\ | | | | 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-021-1/+14
| | | | | | | | | | 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.
* commentsChris Holdgraf2020-07-291-5/+2
|
* rearranging a few docs and small updatesChris Holdgraf2020-07-291-2/+2
|
* flake8Chris Holdgraf2020-07-291-1/+2
|
* several documentation improvements to theming, templating, and extension ↵Chris Holdgraf2020-07-292-10/+30
| | | | 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
| |
* | Add docs and CHANGES for C changesJakob Lykke Andersen2020-07-141-0/+17
| |
* | Update description of autosummary_generate_overwriteJohannes Lade2020-07-131-1/+1
| | | | | | The old description was confusing. Maybe it's just me not being a native speaker, but I think it was wrongly worded.
* | Close #7902: html theme: Add a new option globaltoc_maxdepthTakeshi KOMIYA2020-07-111-0/+6
| |
* | Close #7849: html: Add html_codeblock_linenos_styleTakeshi KOMIYA2020-07-111-0/+9
| |
* | doc: Add translation.png to build latexpdf successfullyTakeshi KOMIYA2020-07-071-1/+1
|/
* Merge pull request #7906 from jakobandersen/noindexentryJakob Lykke Andersen2020-07-051-3/+17
|\ | | | | Add :noindexentry: option
| * Add :noindexentry: optionJakob Lykke Andersen2020-07-041-3/+17
| | | | | | | | Fixes sphinx-doc/sphinx#7052
* | doc: Update docs (refs: #7907)Takeshi KOMIYA2020-07-041-5/+5
| |
* | Use double backticks for filename exampleTim Metzler2020-07-031-1/+1
| |
* | Shorten line to less than 85 charactersTim Metzler2020-07-031-3/+3
| |
* | Clarify language specific figures formatTim Metzler2020-07-031-2/+3
|/ | | | I recently used sphinx for multilanguage documentation and found the explanation of the language specific figure format misleading. I replaced the underscores by periods and added a small example.
* Merge pull request #7895 from jakobandersen/c_cpp_noindexJakob Lykke Andersen2020-07-021-1/+0
|\ | | | | C, C++: remove noindex option
| * C, C++: remove noindex optionJakob Lykke Andersen2020-06-301-1/+0
| | | | | | | | | | The option did nothing. Improve error messages on duplicates.
* | C, add c:alias directiveJakob Lykke Andersen2020-06-301-0/+35
|/
* napoleon: Add aliases Warn and RaiseNguyễn Gia Phong2020-06-291-0/+2
|
* doc: Add modname separator tip for autodoc (refs: #7841)Takeshi KOMIYA2020-06-211-0/+6
|
* Fix typoTakeshi KOMIYA2020-06-061-1/+1
|
* Merge pull request #7760 from Cielquan/feature/coverage_print_missing_as_warningTakeshi KOMIYA2020-06-061-1/+8
|\ | | | | coverage ext - config to log missing coverage
| * documented coverage_show_missing_items confvalChristian Riedel2020-06-051-1/+8
| |
* | Close #7247: linkcheck: Add linkcheck_request_headersTakeshi KOMIYA2020-06-011-0/+26
| |
* | Merge pull request #7748 from ↵Takeshi KOMIYA2020-05-311-0/+7
|\ \ | |/ |/| | | | | tk0miya/2106_autodoc_docstring_signature_for_overloads Close #2106: autodoc: Support multiple signatures on docstring
View Lorry Controller Status