Commit Graph
2867 Commits
Author SHA1 Message Date
Takeshi KOMIYA 78d407cf83 Update CHANGES for PR #8404 2020-11-14 18:55:25 +09:00
François Freitag 683635f5b4 linkcheck: Remove call to is_ssl_error()
This method always returns False, it is dead code. The exception
checking stopped working because Requests library wraps SSL errors in a
`requests.exceptions.SSLError` and no longer throws an
`urllib3.exceptions.SSLError`. The first argument to that exception is
an `urllib3.exceptions.MaxRetryError`.
2020-11-12 19:58:04 +01:00
François Freitag 0949735210 Sort imports with isort
Keep imports alphabetically sorted and their order homogeneous across
Python source files.

The isort project has more feature and is more active than the
flake8-import-order plugin.

Most issues caught were simply import ordering from the same module.
Where imports were purposefully placed out of order, tag with
isort:skip.
2020-11-11 13:19:05 +01:00
Takeshi KOMIYA 1955a08378 Merge branch '3.x' into 8105_incorrect_class_constructor 2020-11-08 12:34:09 +09:00
Takeshi KOMIYA cad02e62e6 Fix #8375: URL of transifex project page 2020-11-05 23:52:59 +09:00
Takeshi KOMIYA 6d05b1aeb3 Fix #8105: autodoc: the signature of decorated class is incorrect
In #7651, autodoc stops to undecorate the functions on getting the
signature from the callables.  But some kinds of decorators conceals
the correct signature because they pass through their arguments via
`(*args, **kwargs)`.

This restarts to undecorate the functions again as before #7651.
2020-11-05 01:57:40 +09:00
Takeshi KOMIYA c028fb7a40 Merge pull request #8359 from sphinx-doc/8349_sphinx-contrib
doc: Update sphinx-contrib repos' URL (refs: #8349)
2020-11-03 11:29:31 +09:00
Takeshi KOMIYA 0e98e9b1a8 Fix #6914: Emit a detailed warning when failed to resolve :ref:
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.
2020-11-03 02:27:43 +09:00
Takeshi KOMIYA 11edef1a26 doc: Update sphinx-contrib repos' URL (refs: #8349) 2020-11-03 02:13:05 +09:00
Takeshi KOMIYA b453be75c9 Fix #8298: sphinx-quickstart: Add :option:sphinx-quickstart --no-sep option 2020-10-26 01:12:36 +09:00
Takeshi KOMIYA f26569007b Merge pull request #8334 from mgeier/doc-favicon
DOC: Add favicon
2020-10-25 18:47:30 +09:00
Jon Dufresne 554bb5e9b9 Fix docs type: "the builder builders" → "builders" 2020-10-24 09:35:22 -07:00
Matthias Geier 84c6d693f4 DOC: Add favicon 2020-10-24 17:41:02 +02:00
Takeshi KOMIYA 3b85187ffa Merge pull request #8289 from graingert/allow-to-suppress-duplicated-toc
Allow to suppress "duplicated toc entry" warnings from epub builder
2020-10-24 20:29:06 +09:00
Thomas Grainger 3f26564c28 Apply suggestions from code review 2020-10-05 22:10:25 +01:00
Thomas Grainger 3eecf133d8 Fix #8289: Allow to suppress "duplicated ToC entry found" warnings from epub builder 2020-10-05 09:29:16 +01:00
François Freitag bd49c3c2ef Outdated comment in docs config for intersphinx
Intersphinx is in use since 6a396c7eb8.
2020-10-05 08:34:26 +02:00
Takeshi KOMIYA 38bb377464 Merge pull request #8273 from sphinx-doc/7996_man_make_section_directory
Close #7996: manpage: Add man_make_section_directory
2020-10-04 22:40:41 +09:00
Takeshi KOMIYA 2d37ba4419 autodoc: deprecate SingledispatchFunctionDocumenter
In #7487, SingledispatchFunctionDocumenter is merged into
FunctionDocumenter.  SingledispatchMethodDocumenter is also.  As a result,
They are no longer needed.  So this deprecates them.
2020-10-04 13:50:10 +09:00
Takeshi KOMIYA 178c05b059 Close #7996: manpage: Add man_make_section_directory
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.
2020-10-03 22:30:20 +09:00
François Freitag 5166dd194c Strip trailing whitespaces and normalize line endings
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.
2020-10-03 13:47:01 +02:00
Takeshi KOMIYA f2c0dfe7c4 Close #6518: autodoc: Add autodoc_type_aliases
autodoc_type_aliases allows to keep user defined type alises not
evaluated in the generated document.
2020-10-03 16:03:35 +09:00
Bradley Dice a0116eaa58 Fix typo: anchestor -> ancestor. 2020-09-20 17:36:01 -05:00
Takeshi KOMIYA 5ef4825b57 Close #8081: latex: Allow to add LaTeX package until writing tex file
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.
2020-09-21 01:01:49 +09:00
Jakob Lykke Andersen 500f45fd4c C, recursive alias declarations
Fixes sphinx-doc/sphinx#8141
2020-09-13 16:37:53 +02:00
Patrick Decat 7a3170b77a Fix some broken links 2020-09-03 15:22:50 +02:00
Falko Axmann 849ef212bc Fixes minor typo in quickstart.rst 2020-08-30 14:39:20 +02:00
Takeshi KOMIYA ae9f0dd299 Merge pull request #8140 from chrisjsewell/docs/execution-process
📚 DOCS: Improve build process overview
2020-08-22 00:21:26 +09:00
Chris Sewell 46177f6af3 Correct numbers 2020-08-21 01:58:28 +01:00
Chris Sewell 5c744d8342 📚 DOCS: Improve build process overview 2020-08-20 22:37:37 +01:00
Yves Chevallier e45f55d32f Add rubric in Getting help 2020-08-15 13:34:57 +02:00
Takeshi KOMIYA dab15e2857 Merge pull request #8058 from nijel/single-domain
i18n: Add support for having single text domain
2020-08-14 14:21:43 +09:00
Michal Čihař 1bf7fe424e i18n: Add support for having single text domain
The gettext_compact can now be a string which is then a single domain
for all documents.

Fixes #784
2020-08-07 20:22:30 +02:00
Matt from Documatt db9375363c Add link to third party themes on GitLab
GitLab, alternative to GitHub, also contains a lot of beautiful open source themes.
2020-08-07 14:46:19 +02:00
Takeshi KOMIYA f743be0054 Merge pull request #8047 from cjmayo/typos
Assorted typos including sphinx-buid in internationalization figure
2020-08-06 02:38:07 +09:00
Takeshi KOMIYA 059dc108ba Close #6698: doctest: Add :no-trim-doctest-flags: options
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).
2020-08-05 23:39:05 +09:00
Chris Mayo 9bac86a2fc Fix typo sphinx-buid in internationalization figure 2020-08-03 19:30:38 +01:00
Chris Mayo fe4a158caf Fix typos in the documentation 2020-08-03 19:30:38 +01:00
Takeshi KOMIYA 46f0b3063d refactor: autodoc: Add EMPTY that matches to no members
Add a special class `_Empty` to make the comparison of
:exclude-members: option simply.  It never matches to any members.
2020-08-03 01:59:53 +09:00
Takeshi KOMIYA 57af828882 Merge pull request #8035 from tk0miya/8034_argument_for_private-members
Close #8034: autodoc: :private-member: can take an list of member names
2020-08-03 01:57:13 +09:00
Takeshi KOMIYA af15593c0c Close #7768: i18n: figure_language_filename supports {docpath} token
To build structured i18n imaging directory, figure_language_filename
now supports `{docpath}` token that is a dirname of the current
document.
2020-08-02 16:28:54 +09:00
Takeshi KOMIYA d7a84e83cc Close #8034: autodoc: :private-member: can take an list of member names
Now :private-member: option can take an explicit list of member names to
be documented as its arguments (like :special-members: does).
2020-08-02 01:27:14 +09:00
Takeshi KOMIYA f71b26ac56 Merge branch '3.x' into 7993_texinfo_for_nested_desc 2020-08-01 15:50:55 +09:00
Chris Holdgraf b8ee3ac9a4 moving extension dev overview 2020-07-29 10:38:18 +01:00
Chris Holdgraf 84f7dffd99 comments 2020-07-29 10:38:18 +01:00
Chris Holdgraf c7085162d1 rearranging a few docs and small updates 2020-07-29 10:38:18 +01:00
Chris Holdgraf 924befa07e Update doc/development/tutorials/builders.rst 2020-07-29 10:38:18 +01:00
Chris Holdgraf 729dcd0e03 flake8 2020-07-29 10:38:18 +01:00
Chris Holdgraf 60b105d6aa several documentation improvements to theming, templating, and extension development 2020-07-29 10:38:18 +01:00
Takeshi KOMIYA e98f39d21d Fix #7993: texinfo: TypeError is raised for nested object descriptions
The texinfo writer remembers the current desc node to render
a desc_annotation node.  This makes the mechanism robust to support
nested object descriptions.
2020-07-25 22:57:12 +09:00