IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
16,344 Commits 2 Branches 219 Tags
4755557a7df0a335b62c3f6bc062ce1c01c2d45a
Commit Graph

3493 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
e3b1fdeeeb Merge branch '3.4.x' into 8602_process-docstring_for_nondatadescriptors 2020-12-31 10:13:03 +09:00
Takeshi KOMIYA
97f36a2d02 Fix #8602: autodoc: The `autodoc-process-docstring` event is emitted to the non-datadescriptors unexpectedly 2020-12-29 18:04:24 +09:00
Takeshi KOMIYA
85567748d9 Fix #8164: autodoc: Classes that inherit mocked class are not documented 
Use ismock() to check a module member is a mocked or not. It allows not
to skip subclasses of mocked class.
 2020-12-29 00:26:23 +09:00
Takeshi KOMIYA
476169284d autodoc: Add a helper that checks the object is mocked; ismock() 2020-12-28 21:50:36 +09:00
François Freitag
a1b8b1febb Ensure linkcheck items are comparable 
Linkcheck organizes the URLs to checks in a PriorityQueue. The items are
tuples (priority, url, docname, lineno).

Tuples where the lineno is `None` are not comparable with tuples that
have an integer lineno, and PriorityQueue items must be comparable (see
https://bugs.python.org/issue31145).

Fixes an issue when a document contains two links to the same URL, one
with an int line number and the other without line number metadata (such
as an image :target: attribute).

Using 0 instead of None to represent no line number should not lead to
observable changes, the result logger only logs the line number when it
is truthy.

Close #8565
 2020-12-22 21:18:31 +01:00
Takeshi KOMIYA
70bb2262d6 Fix #8567: autodoc: Instance attributes are incorrectly added to Parent class 
The instance attributes on subclasses are shown on the document of
parent class unexpectedly because of autodoc modifies `__annotations__`
in place.  This fix creates a copy of `__annotations__` attribute and
attach it to the subclass.
 2020-12-22 02:38:31 +09:00
Takeshi KOMIYA
423e7ab2ca Fix #8559: AttributeError is raised when using ForwardRef 
The restify() helper crashes when ForwardRef is passed.
 2020-12-22 00:37:02 +09:00
Takeshi KOMIYA
6e8ea8572f Merge pull request #8552 from tk0miya/8236_napoleon_receives_section 
Close #8236: napoleon: Support numpydoc's "Receives" section
 2020-12-20 13:54:01 +09:00
Takeshi KOMIYA
7f1284f2e7 Merge pull request #8555 from tk0miya/8512_test_comment 
test: Add comment for UnicodeEncodeError handler (refs: #8512)
 2020-12-20 13:53:24 +09:00
Takeshi KOMIYA
2fa15e9396 Merge pull request #8551 from tk0miya/8365_pydomain_xref_missing_context 
Fix #8365: py domain: :type: and :rtype: gives false ambiguous warnings
 2020-12-20 13:49:53 +09:00
Takeshi KOMIYA
9a9d7f3f00 test: Add comment for UnicodeEncodeError handler (refs: #8512) 2020-12-20 01:01:59 +09:00
Takeshi KOMIYA
aae2f19911 Merge pull request #8512 from jbms/fix-nonascii_srcdir 
Fix nonascii_srcdir to work when non-ascii directories aren't supported
 2020-12-20 00:58:08 +09:00
Takeshi KOMIYA
f50b999911 Close #8236: napoleon: Support numpydoc's "Receives" section 2020-12-19 20:29:00 +09:00
Takeshi KOMIYA
30c594fbc5 Fix #8365: py domain: :type: and :rtype: gives false ambiguous warnings 
The searching context like py:module and py:class are missing in the
pending_xref nodes generated from info-field-lists.  This sets these
searching context info to them.
 2020-12-19 18:42:01 +09:00
Takeshi KOMIYA
c0678a4a50 Fix #741: autodoc: inherited-members doesn't support instance attributes on super class 
To support instance attributes on super class, get_class_members() scans
the instance attributes defined at super classes using ModuleAnalyzer.
It allows to generate document for them when users gives :
inherited-members: option.
 2020-12-18 23:24:59 +09:00
Takeshi KOMIYA
dd1615c59d Merge pull request #8543 from tk0miya/8534_autoattribute_alias_derived 
Fix #8534: autoattribute failed to document a commented attribute in alias dervied class
 2020-12-17 22:35:35 +09:00
Takeshi KOMIYA
9721327989 Fix #8545: autodoc: a __slots__ attribute is not documented even having docstring 
To avoid filtering __slots__ attributes having docstring at
filter_members(), this passes docstring captured at get_class_members()
to the filter_members() via ObjectMember.
 2020-12-17 22:19:28 +09:00
Takeshi KOMIYA
0dbbf1dd54 Fix #8534: autoattribute failed to document a commented attribute in alias dervied class 2020-12-17 22:13:20 +09:00
Takeshi KOMIYA
55c110f609 Fix #8541: autodoc_type_aliases doesn't work for the instance attrs 
So far, autodoc obtains type annotations of instance attributes by
ModuleAnalyzer directly.  As a result, autodoc_type_aliases are ignored
for these variables.

This goes to merge type annotations from the class itself and
ModuleAnalyzer's, and get type annotations using `typing.get_type_hints()`
to apply autodoc_type_aliases.
 2020-12-17 01:07:54 +09:00
Takeshi KOMIYA
caa1d1f3c2 Fix #8534: autoattribute failed to document a commented attribute in alias class 
So far, autoattribute uses "given class name" to fetch comments of
uninitialized instance attributes.  But pycode expects to use "real"
class name on searching attribute comments.

This adds UninitializedInstanceAttributeMixin to handle it simply.
 2020-12-16 02:43:31 +09:00
Jon Dufresne
850512090a Remove duplicate test in test_ext_autodoc.py 
Duplicate since c6bd84a614.
 2020-12-12 06:28:23 -08:00
Jeremy Maitin-Shepard
d737ecd063 Fix nonascii_srcdir to work when non-ascii directories aren't supported 
Previously, the nonascii_srcdir in tests/test_build.py contained some
logic to attempt to handle the case where non-ascii directories aren't
supported, but it did not actually work because it fails to copy the
test sources to the temporary directory.

With this commit, the following test invocation, which previously
failed, now pases:

LANG=en_US.iso8859-1 python -m pytest test_build.py
 2020-11-30 13:13:01 -08:00
Takeshi KOMIYA
9cf2826491 Merge pull request #8506 from tk0miya/8352_option_startswith_bracket 
Fix #8352: std domain: Failed to parse an option that starts with bracket
 2020-11-29 23:58:18 +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
c15c61ed64 Merge pull request #8505 from tk0miya/8501_extract_summary_el_at 
Fix #8501: autosummary: summary extraction splits text after "el at."
 2020-11-29 11:48:55 +09:00
Takeshi KOMIYA
6d24579f40 Fix #8352: std domain: Failed to parse an option that starts with bracket 2020-11-29 02:22:40 +09:00
Takeshi KOMIYA
3f3358b38f Merge pull request #8494 from timoludwig/alias-of-builtin 
Use restify() to reference alias attributes in autodoc
 2020-11-28 22:55:27 +09:00
Timo Ludwig
ccfd98dc07 Fix #8493: Use restify() in autodoc to reference alias attributes 2020-11-28 12:12:02 +01: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
65ca7aa0c9 Fix #8501: autosummary: summary extraction splits text after "el at." 
Add "el at." to the list of abbreviations.
 2020-11-28 11:41:06 +09:00
Jon Dufresne
c1437d5f79 Replace modify_env() with pytest monkeypatch.setenv() 
The same test utility function is built into pytest. Can avoid the
duplication.

https://docs.pytest.org/en/latest/monkeypatch.html#monkeypatching-environment-variables
 2020-11-27 14:10:36 -08:00
François Freitag
236afac7fd Unset env variables in tests by del os.environ 
The `unsetenv()` operation does not update `os.environ`.
https://docs.python.org/3/library/os.html#os.unsetenv
 2020-11-26 21:12:28 +01: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
Quentin Soubeyran
c37ef640a7 rebased on upstream/3.x; fixed CI 2020-11-25 08:49:57 +01:00
Quentin Soubeyran
ec62bf86fa implemented feature in numpy style, factored common code 2020-11-25 08:45:25 +01:00
Quentin Soubeyran
ec30f77712 refactored code and tests, prepared for numpy feature 2020-11-25 08:45:25 +01:00
Quentin Soubeyran
a60e1c10b7 sorted imports 2020-11-25 08:45:25 +01:00
Quentin Soubeyran
8995f15710 moved python 3.6+ syntax test data to standalone file 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
c941406415 refactor with pyupgrade 
Run `pyupgrade --py3-only --keep-percent-format` to refine our code.

Note:  --keep-percent-format is required to keep translations available.
 2020-11-25 01:55:30 +09:00
Takeshi KOMIYA
c941b9cb14 Merge pull request #8481 from tk0miya/8480_slots_attributes 
Fix #8480: autoattribute could not create document for __slots__ attributes
 2020-11-24 21:53:48 +09:00
Takeshi KOMIYA
3e9200dab4 Merge pull request #8474 from tk0miya/8360_update_warning_for_numref 
Fix #8360: Update warning message for numref
 2020-11-24 21:38:04 +09:00
Takeshi KOMIYA
0131f776fb Merge pull request #8475 from tk0miya/8131_too_many_redirects 
Extend linkchecker GET fallback logic to handle Too Many Redirects
 2020-11-23 17:16:51 +09:00
Takeshi KOMIYA
50dad211ed Fix #8480: autoattribute could not create document for __slots__ attributes 2020-11-23 15:28:53 +09:00
Takeshi KOMIYA
046c289f76 linkcheck: Add a testcase for infinite redirect loop on HEAD request 2020-11-23 01:52:44 +09:00
Takeshi KOMIYA
478a1567b6 Fix #8360: Update warning message for numref 2020-11-23 01:36:35 +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
24a329eebe Merge pull request #8465 from tk0miya/8460_NewType 
Fix #8460: autodoc: Support custom types defined by typing.NewType
 2020-11-22 13:47:39 +09:00
Takeshi KOMIYA
8bb31c7e3a Merge pull request #8469 from tk0miya/refactor_test_ext_autodoc_slots 
refactor: Rename example class
 2020-11-22 11:42:13 +09:00