summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* A happy new year!Takeshi KOMIYA2021-01-011-1/+1
| | | | | | | .. 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
* refactor: Move _getmro() to sphinx.util.inspect moduleTakeshi KOMIYA2020-12-171-0/+5
|
* Deprecate sphinx.util.osutil.movefile() in favor of os.replace()Jon Dufresne2020-12-131-0/+5
| | | | | | | The utility function movefile() was added in 677d096393bca948eea8fad252bd859ed8142309 to handle existing files on Windows. Since Python 3.3, the stdlib function os.replace() fills this role.
* Merge pull request #8533 from tk0miya/deprecate_no_docstringTakeshi KOMIYA2020-12-141-0/+6
|\ | | | | refactor: Deprecate `no_docstring` argument for Documenter.add_content()
| * refactor: Deprecate `no_docstring` argument for Documenter.add_content()Takeshi KOMIYA2020-12-131-0/+6
| | | | | | | | | | | | 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.
* | Describe the intersphinx mapping a bit moreNed Batchelder2020-12-131-3/+14
|/
* Fix #8503: autoattribute could not create document for a GenericAliasTakeshi KOMIYA2020-11-291-0/+5
|
* Merge pull request #8291 from ↵Takeshi KOMIYA2020-11-282-1/+55
|\ | | | | | | | | QuentinSoubeyran/8285_napoleon_google_style_use_annotations Fix #8285: napoleon can use PEP526 annotations
| * refactored code and tests, prepared for numpy featureQuentin Soubeyran2020-11-252-6/+8
| |
| * added napoleon_google_attr_annotations option to use PEP 526 on google styleQuentin Soubeyran2020-11-252-1/+53
| |
* | Merge pull request #8488 from tk0miya/deprecate_InstanceAttributeDecoratorTakeshi KOMIYA2020-11-261-0/+5
|\ \ | | | | | | refactor: Deprecate InstanceAttributeDocumenter
| * | refactor: Deprecate InstanceAttributeDocumenterTakeshi KOMIYA2020-11-261-0/+5
| |/ | | | | | | | | InstanceAttributeDocumenter is merged into AttributeDocumenter in #7946 and #8444. So it is no longer needed now.
* | Fix #6629: linkcheck: Handle rate-limitingFrançois Freitag2020-11-253-1/+25
|/ | | | | Follow the Retry-After header if present, otherwise use an exponential back-off.
* Deprecate SlotsAttributeDocumenterTakeshi KOMIYA2020-11-241-0/+5
|
* Merge branch '3.x' into 8460_TypeVarTakeshi KOMIYA2020-11-231-0/+10
|\
| * Merge pull request #8464 from tk0miya/deprecate_Documenter.get_object_membersTakeshi KOMIYA2020-11-231-0/+5
| |\ | | | | | | Deprecate Documenter.get_object_members()
| | * Deprecate Documenter.get_object_members()Takeshi KOMIYA2020-11-211-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | 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().
| * | refactor: Move _getannotations() to sphinx.util.inspectTakeshi KOMIYA2020-11-221-0/+5
| | |
* | | Fix #8460: autodata directive does not display the detail of TypeVarsTakeshi KOMIYA2020-11-221-0/+5
|/ / | | | | | | | | The details are only shown when automodule directive is used. This allows to document them via other auto* directives.
* | Rename ModuleAnalyzer.parse() to analyze()Takeshi KOMIYA2020-11-221-0/+5
|/ | | | | The word "analyze" is much appropriate for "ModuleAnalyzer" instead of "parse".
* Fix #8443: autodata directive does not support PEP-526 ivarsTakeshi KOMIYA2020-11-201-0/+5
|
* Rename :novalue: option to :no-value: optionTakeshi KOMIYA2020-11-151-5/+5
| | | | | According to the existing options of autodoc directives, `:novalue:` option is now renamed to `:no-value:` option.
* autodoc: document :novalue: optionMarlon James2020-11-151-0/+12
|
* Update CHANGES for PR #8404Takeshi KOMIYA2020-11-141-3/+2
|
* linkcheck: Remove call to is_ssl_error()François Freitag2020-11-121-0/+5
| | | | | | | | 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`.
* Sort imports with isortFrançois Freitag2020-11-112-3/+1
| | | | | | | | | | | | 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.
* Merge branch '3.x' into 8105_incorrect_class_constructorTakeshi KOMIYA2020-11-081-3/+3
|\
| * Fix #8375: URL of transifex project pageTakeshi KOMIYA2020-11-051-3/+3
| |
* | Fix #8105: autodoc: the signature of decorated class is incorrectTakeshi KOMIYA2020-11-051-0/+6
|/ | | | | | | | | 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.
* 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.
* 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
|
View Lorry Controller Status