Commit Graph
2890 Commits
Author SHA1 Message Date
Takeshi KOMIYA f996859420 A happy new year!
.. note::

   $ find sphinx tests LICENSE doc/conf.py -type f -exec sed -i '' -e 's/2007\-20../2007-2021/' {} \;
   $ git co sphinx/locale/**/*.js sphinx/templates/epub3/mimetype
2021-01-01 13:40:48 +09:00
Takeshi KOMIYA 36e684bf83 refactor: Move _getmro() to sphinx.util.inspect module 2020-12-17 00:46:42 +09:00
Jon Dufresne cb4f76fca2 Deprecate sphinx.util.osutil.movefile() in favor of os.replace()
The utility function movefile() was added in
677d096393 to handle existing files on
Windows. Since Python 3.3, the stdlib function os.replace() fills this
role.
2020-12-13 09:36:10 -08:00
Takeshi KOMIYA 399210c807 Merge pull request #8533 from tk0miya/deprecate_no_docstring
refactor: Deprecate `no_docstring` argument for Documenter.add_content()
2020-12-14 01:32:42 +09:00
Ned Batchelder bac6ab8d0c Describe the intersphinx mapping a bit more 2020-12-13 08:04:55 -05:00
Takeshi KOMIYA 3638a9e4d1 refactor: Deprecate no_docstring argument for Documenter.add_content()
This deprecates `no_docstring` argument for Documenter.add_content().
After this change, please use Documenter.get_doc() to control (suppress)
the content of the python object.
2020-12-13 02:11:53 +09:00
Takeshi KOMIYA bb63f03034 Fix #8503: autoattribute could not create document for a GenericAlias 2020-11-29 12:24:10 +09:00
Takeshi KOMIYA da4c69c624 Merge pull request #8291 from QuentinSoubeyran/8285_napoleon_google_style_use_annotations
Fix #8285: napoleon can use PEP526 annotations
2020-11-28 18:11:30 +09:00
Takeshi KOMIYA e6e23aa45b Merge pull request #8488 from tk0miya/deprecate_InstanceAttributeDecorator
refactor: Deprecate InstanceAttributeDocumenter
2020-11-26 20:13:03 +09:00
François Freitag 6b90a63f08 Fix #6629: linkcheck: Handle rate-limiting
Follow the Retry-After header if present, otherwise use an exponential
back-off.
2020-11-25 17:34:55 +01:00
Takeshi KOMIYA 93c9ce5cd8 refactor: Deprecate InstanceAttributeDocumenter
InstanceAttributeDocumenter is merged into AttributeDocumenter in #7946
and #8444. So it is no longer needed now.
2020-11-26 01:22:25 +09:00
Quentin Soubeyran ec30f77712 refactored code and tests, prepared for numpy feature 2020-11-25 08:45:25 +01:00
Quentin Soubeyran f268665292 added napoleon_google_attr_annotations option to use PEP 526 on google style 2020-11-25 08:45:25 +01:00
Takeshi KOMIYA ab844c3f27 Deprecate SlotsAttributeDocumenter 2020-11-24 19:36:14 +09:00
Takeshi KOMIYA 5ebacaec89 Merge branch '3.x' into 8460_TypeVar 2020-11-23 13:58:41 +09:00
Takeshi KOMIYA 64498ad0db Merge pull request #8464 from tk0miya/deprecate_Documenter.get_object_members
Deprecate Documenter.get_object_members()
2020-11-23 13:24:20 +09:00
Takeshi KOMIYA a57ce4047c refactor: Move _getannotations() to sphinx.util.inspect 2020-11-22 15:38:01 +09:00
Takeshi KOMIYA 9eb96d5c79 Fix #8460: autodata directive does not display the detail of TypeVars
The details are only shown when automodule directive is used.  This
allows to document them via other auto* directives.
2020-11-22 13:57:48 +09:00
Takeshi KOMIYA 8e29d57395 Rename ModuleAnalyzer.parse() to analyze()
The word "analyze" is much appropriate for "ModuleAnalyzer" instead
of "parse".
2020-11-22 02:59:29 +09:00
Takeshi KOMIYA 7e3ba5ddf6 Deprecate Documenter.get_object_members()
At present, the implementation of Documenter.get_object_members() is
only for class objects.  In fact, no subclasses use it (all of them are
overriding the method).

This deprecates Documenter.get_object_members() and copies it to
ClassDocumenter.get_object_members().
2020-11-21 15:42:46 +09:00
Takeshi KOMIYA f344fff55e Fix #8443: autodata directive does not support PEP-526 ivars 2020-11-20 22:38:58 +09:00
Takeshi KOMIYA 5676fdeb4e Rename :novalue: option to :no-value: option
According to the existing options of autodoc directives, `:novalue:`
option is now renamed to `:no-value:` option.
2020-11-15 14:20:30 +09:00
Marlon James 6082ce67a4 autodoc: document :novalue: option 2020-11-15 14:19:33 +09:00
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