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,391 Commits 2 Branches 219 Tags 163 MiB
a1d501d876
Commit Graph

16391 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Takeshi KOMIYA
a1d501d876
Merge pull request #8615 from tk0miya/refactor_autodoc 
refactor: autodoc: Replace ClassAttribute by ObjectMember
 2020-12-31 10:44:09 +09:00
Takeshi KOMIYA
21698c1446
Merge pull request #8614 from tk0miya/deprecate_AttributeDocumenter_isinstanceattribute 
refactor: Deprecate AttributeDocumenter.isinstanceattribute()
 2020-12-30 19:47:17 +09:00
Takeshi KOMIYA
839d2594a2 refactor: autodoc: Replace ClassAttribute by ObjectMember 
After the series of refactoring, it would be better to use ObjectMember
directly inside get_class_members(). And ClassAttribute is no longer
needed.
 2020-12-30 12:17:05 +09:00
Takeshi KOMIYA
c99412695d
Merge pull request #8292 from tk0miya/update_coding_style 
docs: Update coding style
 2020-12-30 01:44:03 +09:00
Takeshi KOMIYA
c0f923ee6c refactor: Deprecate AttributeDocumenter.isinstanceattribute() 2020-12-29 20:06:29 +09:00
Takeshi KOMIYA
ae9768385a Merge branch '3.4.x' into 3.x 2020-12-29 19:40:40 +09:00
Takeshi KOMIYA
3f560cd672
Merge pull request #8612 from tk0miya/reduce_Warning 
refactor: Reduce warnings on testing
 2020-12-29 19:39:41 +09:00
Takeshi KOMIYA
935d7425cc
Merge pull request #8613 from tk0miya/refactor_autosummary_warnings 
refactor: autosummary: Do not import deprecated documenter; SingledispatchFunctionDocumenter
 2020-12-29 19:38:57 +09:00
Takeshi KOMIYA
40a354425a refactor: autosummary: Do not import deprecated documenter; SingledispatchFunctionDocumenter 2020-12-29 19:25:35 +09:00
Takeshi KOMIYA
f054b9b976 refactor: Reduce warnings on testing 2020-12-29 19:23:46 +09:00
Takeshi KOMIYA
3f7bf48715 Merge branch '3.4.x' into 3.x 2020-12-29 18:33:36 +09:00
Takeshi KOMIYA
aaee3520f3
Merge pull request #8607 from tk0miya/8164_subclass_of_mocked_class 
Fix #8164: autodoc: Classes that inherit mocked class are not documented
 2020-12-29 18:31:53 +09:00
Takeshi KOMIYA
b24ae7e206
Merge pull request #8610 from tkoyama010/patch-1 
🆕 FreeFEM in EXAMPLES
 2020-12-29 11:14:25 +09:00
Tetsuo Koyama
6fcc4daa73
🆕 FreeFEM in EXAMPLES 2020-12-29 03:19:46 +09:00
Takeshi KOMIYA
3f8f6b5fa1
Merge pull request #8609 from altendky/patch-1 
Minor docstring typo fix -> existence
 2020-12-29 01:52:23 +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
1a659c6ca7 testing: Add rollback_sysmodules fixture to unload modules after tests 2020-12-29 00:26:23 +09:00
Kyle Altendorf
46055367cf
Minor docstring typo fix -> existence 2020-12-28 10:02:17 -05:00
Takeshi KOMIYA
476169284d autodoc: Add a helper that checks the object is mocked; ismock() 2020-12-28 21:50:36 +09:00
Takeshi KOMIYA
f18e988dea
Merge pull request #8601 from tk0miya/8306_autosummary_mocks_are_documented 
Fix #8306: autosummary: mocked modules are documented as empty page
 2020-12-28 17:42:22 +09:00
Takeshi KOMIYA
150f788e0e
Merge pull request #8600 from tk0miya/8132_project_copyright 
Close #8132: Add project_copyright confval as an alias of copyright
 2020-12-28 17:26:49 +09:00
Takeshi KOMIYA
05518851d3
Merge branch '3.x' into 8306_autosummary_mocks_are_documented 2020-12-28 17:25:09 +09:00
Takeshi KOMIYA
91fa0ceb22
Merge pull request #8598 from tk0miya/8094_texinfo_images_not_copied 
Fix #8094: texinfo: images on the different directory with document are not copied
 2020-12-28 17:24:23 +09:00
Takeshi KOMIYA
a4da54c4d6
Merge pull request #8605 from xuhdev/patch-1 
Doc: Correct type: "TypeAlias" -> "AliasType"
 2020-12-28 16:49:17 +09:00
Takeshi KOMIYA
146092e35a
Merge branch '3.x' into 8094_texinfo_images_not_copied 2020-12-28 16:48:02 +09:00
Takeshi KOMIYA
119ddf92ff
Merge pull request #8595 from tk0miya/8594_empty_all 
Fix #8594: autodoc: empty __all__ attribute is ignored
 2020-12-28 16:47:31 +09:00
Hong Xu
d9ca895dbb
Update autodoc.rst 2020-12-27 21:24:19 -08:00
Hong Xu
6927130ff1
Doc: Correct type: "TypeAlias" -> "AliasType" 2020-12-27 21:23:31 -08:00
Takeshi KOMIYA
c5a9d04d45
Merge branch '3.x' into 8132_project_copyright 2020-12-28 13:56:11 +09:00
Takeshi KOMIYA
0d84818739 Fix #8594: autodoc: empty __all__ attribute is ignored 
An empty `__all__` should be represented as "there is no public items".
But autodoc considers all items on the module are public.  This changes
the behavior to correct one.
 2020-12-28 13:53:56 +09:00
Takeshi KOMIYA
b19bce971e
Merge pull request #8593 from tk0miya/8592_meta_public_doesnt_affect_to_variables 
Fix #8592: autodoc: `:meta public:` does not effect to variables
 2020-12-28 13:51:50 +09:00
Takeshi KOMIYA
556b9743fe
Merge pull request #8596 from tk0miya/8022_meta_hide_value 
Close #8022: autodoc: Allow to hide the value of the variables via metadata
 2020-12-28 12:15:56 +09:00
Takeshi KOMIYA
ce52a90d92 Fix #8592: autodoc: :meta public: does not effect to variables 
To control the visibility of variables, ModuleDocumenter have to load
docstring of them on `get_object_members()` phase.  This reimplements
it and `get_module_members()` helper to fetch docstring on earlier
phase (as ClassDocumenter does).
 2020-12-27 22:21:34 +09:00
Takeshi KOMIYA
07983a5a87
Merge pull request #8589 from tk0miya/8581_deprecate_no_docstrings 
refactor: Deprecate `no_docstring` argument for Documenter.add_content()
 2020-12-27 22:19:30 +09:00
Takeshi KOMIYA
c86e92cb95 Fix #8306: autosummary: mocked modules are documented as empty page 
The :recursive: option for autosummary directive creates an empty page
for mocked modules unexpectedly.  This make them ignored.
 2020-12-27 21:45:15 +09:00
Takeshi KOMIYA
c7d1536828 Close #8132: Add project_copyright confval as an alias of copyright 
Avoid to pylint error, add a new config variable; project_copyright
as an alias of `copyright`.
 2020-12-27 18:40:06 +09:00
Takeshi KOMIYA
703813a8c1 Fix #8094: texinfo: images on the different directory with document are not copied 2020-12-27 14:51:56 +09:00
Takeshi KOMIYA
9e9e486e65 Close #8022: autodoc: Allow to hide the value of the variables via metadata 
autodata and autoattribute directives does not show right-hand value of
the variable if its docstring contains ``:meta hide-value:`` in
info-field-list.
 2020-12-27 12:46:03 +09:00
Takeshi KOMIYA
bcebe71c8e refactor: autodoc: Add DataDocumenter.get_module_comment() 
Similar to AttributeDocumenter.get_attribute_comment(), add a helper
method DataDocumenter.get_module_comment()
 2020-12-27 12:25:08 +09:00
Takeshi KOMIYA
4fc93ac13c
Merge pull request #8590 from tk0miya/7875_note_object 
Fix #7875: doc: Add PythonDomain.note_object()
 2020-12-27 11:55:06 +09:00
Takeshi KOMIYA
057a9e444d
Merge pull request #8587 from tk0miya/741_inherited_instance_attributes 
Fix #741: autodoc: inherited-members doesn't support instance attributes on super class
 2020-12-27 11:52:23 +09:00
Takeshi KOMIYA
6c645e41f8 refactor: Deprecate no_docstring argument for Documenter.add_content() 
Deprecate `no_docstring` argument for `Documenter.add_content()` again.

At the first trial (#8533), it changes the behavior of
`autodoc-process-docstring` event; it is emitted unexpectedly for an
alias of class.  But it brings an incompatible change to extensions.
Hence it was partially reverted at #8581.

This keeps not calling the event for an alias of class.  To do that,
now `Documenter.get_doc()` can return None value.
 2020-12-26 21:14:26 +09:00
Takeshi KOMIYA
140ef33469 Fix #7875: doc: Add PythonDomain.note_object() 2020-12-26 21:12:15 +09:00
Takeshi KOMIYA
df29440da8 Fix #741: autodoc: inherited-members doesn't support instance attributes on super class 
It was fixed once, but it does not work expectedly on running Sphinx
from command line.  It only works fine on test script because
:inherited-members: option is recognized as expected.

This fixes the option_spec handler and autodoc itself.

refs: #8548
 2020-12-25 22:37:20 +09:00
Takeshi KOMIYA
ada4f38ad8
Merge pull request #8558 from tk0miya/add_UninitializedInstanceAttributeMixin 
refactor: Add UninitializedInstanceAttributeMixin
 2020-12-25 00:11:25 +09:00
Takeshi KOMIYA
02006e665c
Merge pull request #8563 from tk0miya/refactor_get_attribute_comment 
refactor: autodoc: Move get_attribute_comment() to AttributeDocumenter
 2020-12-25 00:10:14 +09:00
Takeshi KOMIYA
b1a47f879b Merge branch '3.4.x' into 3.x 2020-12-25 00:06:41 +09:00
Takeshi KOMIYA
7ae7eab65d Bump version 2020-12-25 00:05:29 +09:00
Takeshi KOMIYA
f5406b9187 Bump to 3.4.1 final 2020-12-25 00:04:05 +09:00
Takeshi KOMIYA
5ba725724d refactor: Add UninitializedInstanceAttributeMixin 
Add a new mix-in for uninitialized instance attributes that is defined
with annotation but not initialized (based on PEP-526).
 2020-12-25 00:00:52 +09:00