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
17,616 Commits 2 Branches 219 Tags
46c2e45aa69da739dee89a97c21f20253d1f61cc
Commit Graph

3781 Commits

Author SHA1 Message Date
Takeshi KOMIYA
5c275191b6 Merge pull request #9282 from tk0miya/9280_exceptions 
Fix #9280: py domain: "exceptions" module is not displayed
 2021-05-30 22:09:34 +09:00
Takeshi KOMIYA
201f61f722 Fix #9280: py domain: "exceptions" module is not displayed 
Since v0.2, python domain gives a special treatment for the exceptions
module to suppress its name on documenting exception classes.  It had
been worthy on python2 era.  But the module has been removed since
python3.  Therefore, the special treatment becomes harmful for user
libraries.  This removes it to render module names correctly.

Note: Now we've only supported python3.  So this is not incompatible.
 2021-05-30 03:46:55 +09:00
Takeshi KOMIYA
31ec519d38 Close #9272: autodoc: Render enum values for the default argument value better 2021-05-30 02:15:28 +09:00
Takeshi KOMIYA
830b3fbe2b Merge pull request #9261 from tk0miya/9250_inherited_docstring 
Fix #9250: autodoc: The inherited method not having docstring is wrongly parsed
 2021-05-24 01:24:23 +09:00
Takeshi KOMIYA
2ddc1d0681 Merge pull request #9258 from tk0miya/1874_piped_types_in_info-field-list 
Close #1874: py domain: Support union types using `|` in info-field-list
 2021-05-23 00:42:56 +09:00
Takeshi KOMIYA
0fb8e33f32 Fix #9250: autodoc: The inherited method not having docstring is wrongly parsed 
`sphinx.util.inspect.getdoc()` clean the docstring up if the method is
inherited and not having docstring.  That causes indentations are
removed on processing it.
 2021-05-23 00:39:05 +09:00
Takeshi KOMIYA
5a8dec457a refactor: reduce calls of find_pending_xref_conditions (refs: #9240) 
After #9246, `find_pending_xref_conditions()` should be only called from
intended modules.  At present, the Python Domain is the only module to
call it intendedly.  Therefore, this removes the needless calls of the
utility function from "unintended" modules.
 2021-05-22 15:34:30 +09:00
Takeshi KOMIYA
a1b0e55548 Close #1874: py domain: Support union types using | in info-field-list 2021-05-22 01:55:43 +09:00
Takeshi KOMIYA
9a132b4f81 Merge branch '4.x' into 9224_type_containing_whitespace 2021-05-19 23:04:48 +09:00
Takeshi KOMIYA
567ff22716 Merge pull request #9231 from tk0miya/9217_manpage_section_directory 
Fix #9217: manpage: Dirname of man_make_section_directory is wrong
 2021-05-19 23:00:03 +09:00
Takeshi KOMIYA
549f09e048 Merge pull request #9239 from igo95862/https-links 
Upgrade URLs to use HTTPS
 2021-05-19 22:59:19 +09:00
Takeshi KOMIYA
8049cd6925 Merge branch '4.0.x' into 4.x 2021-05-19 22:48:26 +09:00
Takeshi KOMIYA
2d3d668856 Fix #9240: Unknown node error for pending_xref_condition is raised 
Unknown node error for pending_xref_condition is raised if an extension
that does not support the node installs a missing-reference handler.
 2021-05-18 01:55:36 +09:00
Takeshi KOMIYA
79d9701a00 Fix #9217: manpage: Dirname of man_make_section_directory is wrong 
* Correct: man/man1
* Wrong:   man/1
 2021-05-17 23:18:24 +09:00
Takeshi KOMIYA
d6c19126c5 Merge branch '4.0.x' into 4.x 2021-05-17 23:16:27 +09:00
Takeshi KOMIYA
b19dc365fe Merge pull request #9233 from tk0miya/3014_autodoc-process-bases 
Close #3014: autodoc: Add autodoc-process-bases
 2021-05-17 22:50:56 +09:00
Takeshi KOMIYA
bc7087a1a2 Merge branch '4.x' into 3014_autodoc-process-bases 2021-05-17 22:40:27 +09:00
Takeshi KOMIYA
e5f6c77263 refactor: Do config file existence check in Config.read() 2021-05-16 23:48:42 +09:00
igo95862
e67c9e5df1 doc: Upgrade docutils.sourceforge.io links to HTTPS 
Also change any docutils.sourceforge.net link to io
top level domain.
 2021-05-16 15:53:49 +03:00
Takeshi KOMIYA
630e5bd15f manpage: Stop creating a section directory on build manpage by default 2021-05-16 17:06:58 +09:00
Takeshi KOMIYA
8d87dde43b Merge pull request #9232 from tk0miya/9217_dont_make_section_directory 
manpage: Stop creating a section directory on build manpage by default
 2021-05-16 17:02:41 +09:00
Takeshi KOMIYA
d048025238 Merge branch '4.x' into 9218_doccomment_for_aliased_class 2021-05-16 13:57:24 +09:00
Takeshi KOMIYA
51ae283a38 Close #4257: autodoc: Add autodoc_class_signature 
Add `autodoc_class_signature` to separate the class entry and the
definition of `__init__()` method.
 2021-05-16 01:53:48 +09:00
Takeshi KOMIYA
67db20d705 Close #3014: autodoc: Add autodoc-process-bases 
Add `autodoc-process-bases` to modify the base classes of the class
definitions.  This allows the extensions to insert or modify the list
of the base classes via event-handlers.
 2021-05-16 00:46:06 +09:00
Takeshi KOMIYA
fa8117cd2f manpage: Stop creating a section directory on build manpage by default 2021-05-15 22:23:40 +09:00
Takeshi KOMIYA
d9be8f6d4e Fix #9224: info-field-list does not support a type containing space 
So far, DocFieldTransformer has split the field name for `:type:`
and `:param:` at the first whitespace.  Therefore, it does not allow
to use a type containing whitespace (ex. `Dict[str, str]`).

This changes the splitting logic to divide the field name at the last
whitespace (a.k.a `rstrip()`).  It allows to use whitespaces on types.
 2021-05-15 20:31:09 +09:00
Takeshi KOMIYA
4ceedc102d Close #8061, #9218: autodoc: Support variable comment for alias classes 2021-05-15 16:31:40 +09:00
Takeshi KOMIYA
a8c63f7511 Fix #9222: Update Underscore.js to 1.13.1 
underscore.js 1.12.0 has a security announcement (CVE-2021-23358) for
arbitrary code execution.  So it should be upgraded to the latest
version.
 2021-05-13 02:11:17 +09:00
Takeshi KOMIYA
1513d50774 Merge branch '4.0.x' into 4.x 2021-05-13 01:51:57 +09:00
Takeshi KOMIYA
d18840b38d Fix test: the result of stringify_signature() has been changed randomly in py36 2021-05-13 01:40:45 +09:00
Takeshi KOMIYA
c341807991 Merge pull request #9185 from AWhetter/autodoc_typehints_both 
autodoc.typehints can accurately represent overloads
 2021-05-12 00:23:58 +09:00
Takeshi KOMIYA
86091934db Fix #9195: autodoc: The args of typing.Literal are wrongly rendered 
They should be rendered as "repr" form.
 2021-05-11 22:39:30 +09:00
Takeshi KOMIYA
71e732014f Merge branch '4.0.x' into 4.x 2021-05-11 02:35:15 +09:00
Takeshi KOMIYA
4ab0dba755 Fix #9205: py domain: canonical option causes xref resolution error 
The :canonical: option causes "more than one target for
cross-reference" warning because the class having the same name is
registered.
 2021-05-11 01:15:14 +09:00
Ashley Whetter
28d3f8136e autodoc.typehints can accurately represent overloads 2021-05-08 21:34:25 -07:00
Takeshi KOMIYA
d69c35b1a4 Fix #9175: autodoc: Special member is not documented in the module 
The special members are not treated as "attributes".  So they're not
handled by DataDocumenter.  This moves the detection to the earlier
step of filter_members().
 2021-05-08 17:33:33 +09:00
Takeshi KOMIYA
d82c8a7890 Merge pull request #9131 from RuRo/feature/glob-nitpick-ignore 
Ignore nitpick warnings with regular expressions using `nitpick_ignore_regex`
 2021-05-05 23:43:46 +09:00
Takeshi KOMIYA
1f860cb77e Merge pull request #9146 from pbudzyns/autosummary-iattr-include 
Autosummary to include instance attributes
 2021-05-05 22:27:28 +09:00
Takeshi KOMIYA
77da494173 Merge pull request #9153 from tk0miya/9082_python3.10.0a7 
Revert "test: Disable testing with python3.10"
 2021-05-05 22:22:30 +09:00
Takeshi KOMIYA
531a5ae9ef test: Adjust type annotataions in python 3.10.0b1 2021-05-05 22:11:41 +09:00
Takeshi KOMIYA
f31af4b815 Merge branch '4.0.x' into 4.x 2021-05-03 22:31:51 +09:00
Takeshi KOMIYA
110fe1797c Merge pull request #9159 from tk0miya/8588_nested_autodoc_type_aliases 
Fix #8588: autodoc_type_aliases does not support dotted name
 2021-05-03 22:30:01 +09:00
Takeshi KOMIYA
30efa3d947 Merge branch '4.x' into 8597_metadata_only_docstring 2021-05-03 22:11:10 +09:00
Takeshi KOMIYA
caa6579dbd Fix #8872: autodoc: stacked singledispatches are wrongly rendered 
When multiple singledispatch decorators are stacked, the first typehints
are copied to the subsequent definitions unexpectedly.

Now autodoc generates a dummy function not to affect typehints to
subsequent functions.
 2021-05-03 21:51:19 +09:00
Takeshi KOMIYA
8d54010675 Fix test: deprecation warning for extlinks 2021-05-03 18:52:19 +09:00
Takeshi KOMIYA
28ab5f233c Close #8588: autodoc: autodoc_type_aliases supports dotted name 
It allows users to define an alias for a class with module name
like `foo.bar.BazClass`.
 2021-05-03 18:47:47 +09:00
Takeshi KOMIYA
469def56b6 Fix #8597: autodoc: metadata only docstring is treated as undocumented 
The metadata in docstring is invisible content. Therefore docstring
having only metadata should be treated as undocumented.
 2021-05-02 23:17:58 +09:00
ruro
afa80dfe03 add tests for nitpick_ignore_regex 2021-05-02 14:54:00 +03:00
ruro
0aea6d318c add tests for regular nitpick_ignore 2021-05-02 14:53:46 +03:00
ruro
bf2e69ad13 add nitpicky-warnings test root 2021-05-02 14:53:01 +03:00