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,610 Commits 2 Branches 219 Tags 163 MiB
918086b559
Commit Graph

16610 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Takeshi KOMIYA
918086b559 Close #5977: :var: field do not create a cross-reference 
Since its beginning, `:var:` field has created a cross-reference to the
attribute having the same name.  It is meaningful only if the attribute
is documented by `py:attribute` directive.  It means the `:var:` field
and `:attr:` role are almost the same and conflicted.  Additionally,
the cross-reference points incorrect variable if the target is not
documented.

Thus, the cross-reference feature of `:var:` field is disabled.
 2021-01-01 22:53:23 +09:00
Takeshi KOMIYA
9cac2001f7 test: py domain: Add a testcase for :var: field 2021-01-01 18:15:42 +09:00
Takeshi KOMIYA
4b452338f9 Merge branch '3.x' 2021-01-01 13:57:19 +09:00
Takeshi KOMIYA
7ecf6b88aa Merge branch '3.4.x' into 3.x 2021-01-01 13:56:19 +09:00
Takeshi KOMIYA
1544097af5 Merge branch '3.x' 2021-01-01 13:55:12 +09:00
Takeshi KOMIYA
1346ddf317
Merge pull request #8635 from tk0miya/update_copyright 
A happy new year! (Updating copyright)
 2021-01-01 13:51:51 +09:00
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
54ef601049
Merge pull request #8630 from tk0miya/8629_warning_for_html_use_opensearch_twice 
Fix #8629: html: A type warning for html_use_opensearch is shown twice
 2021-01-01 13:14:39 +09:00
Takeshi KOMIYA
b2c9297bd2
Merge pull request #8627 from tk0miya/8315_struct.Struct 
Fix #8315: autodoc: Failed to resolve struct.Struct type annotation
 2021-01-01 13:13:11 +09:00
Takeshi KOMIYA
663074e3ce
Merge pull request #8626 from tk0miya/refactor_test_autosummary 
refactor: test: Use rollback_sysmodules fixture in test_ext_autosummary
 2021-01-01 13:12:35 +09:00
Takeshi KOMIYA
05b67f2a3e
Merge pull request #8633 from tk0miya/merge_3.4.x 
Merge 3.4.x to 3.x
 2021-01-01 13:11:56 +09:00
Takeshi KOMIYA
d82a3c2047
Merge pull request #8625 from tk0miya/refactor_autodoc3 
refactor: autodoc: Allow None value from get_doc()
 2021-01-01 13:08:36 +09:00
Takeshi KOMIYA
63e0127b38 refactor autodoc to adjust new AttributeDocumenter 2020-12-31 21:37:35 +09:00
Takeshi KOMIYA
9ec65ff039 Merge branch '3.4.x' into merge_3.4.x 2020-12-31 21:33:43 +09:00
Takeshi KOMIYA
0f1fcdc113
Merge pull request #8632 from tk0miya/fix_test_markup 
Fix test: missing compound class for kbd tag
 2020-12-31 21:30:56 +09:00
Takeshi KOMIYA
5383846ced
Merge pull request #8622 from tk0miya/8616_AttributeError_for_non_class 
Fix #8616: autodoc: AttributeError when non-class is passed to autoclass
 2020-12-31 21:22:06 +09:00
Takeshi KOMIYA
2eb8927b89 Fix test: missing compound class for kbd tag 2020-12-31 21:20:38 +09:00
Takeshi KOMIYA
1353a7b82f
Merge branch '3.4.x' into 8616_AttributeError_for_non_class 2020-12-31 21:12:29 +09:00
Takeshi KOMIYA
b31b8df9bf
Merge pull request #8620 from tk0miya/8619_compound_kbd 
Close #8619: html: kbd role generates customizable HTML tags for compound keys
 2020-12-31 21:11:42 +09:00
Takeshi KOMIYA
60557715d2 Fix #8629: html: A type warning for html_use_opensearch is shown twice 2020-12-31 18:45:00 +09:00
Takeshi KOMIYA
62a0ee3fef Merge branch '3.x' 2020-12-31 14:33:09 +09:00
Takeshi KOMIYA
f1a051fdfc Fix #8315: autodoc: Failed to resolve struct.Struct type annotation 
The builtin module, ``struct.Struct`` does not have correct module
name since Python 3.8.  This allows to refer it automatically.
 2020-12-31 14:25:05 +09:00
Takeshi KOMIYA
332d80ba84
Merge pull request #8621 from tk0miya/8618_kbd_for_single_separator 
Fix #8618: html: incorrect HTML for single compound-kdb separators
 2020-12-31 10:57:40 +09:00
Takeshi KOMIYA
54e8b8d9bc refactor: test: Use rollback_sysmodules fixture in test_ext_autosummary 2020-12-31 10:55:45 +09:00
Takeshi KOMIYA
2e0ea32111 refactor: autodoc: Allow None value from get_doc() 
Now Documenter.get_doc() can reeturn None if it can't have any docstring.
So its caller should handle None value.
 2020-12-31 10:51:53 +09:00
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
1dd0cc8494
Merge pull request #8611 from tk0miya/8602_process-docstring_for_nondatadescriptors 
Fix #8602: autodoc: The ``autodoc-process-docstring`` event is emitted to the non-datadescriptors unexpectedly
 2020-12-31 10:43:20 +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
0f8debe558 Fix #8616: autodoc: AttributeError when non-class is passed to autoclass 
Since 3.4.0, AttributeError is raised when non-class object is passed to
the autoclass directive.  It has built successfully before 3.4.0
release.  So this handles the exception on generating "alias" text.
 2020-12-30 23:29:06 +09:00
Takeshi KOMIYA
6a53c53d53 Fix #8618: html: incorrect HTML for single compound-kdb separators 2020-12-30 21:12:00 +09:00
Takeshi KOMIYA
8e5f4e5616 Close #8619: html: kbd role generates customizable HTML tags for compound keys 2020-12-30 20:36: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
4eab5e8950 Fix mypy violations 2020-12-29 18:58:58 +09:00
Takeshi KOMIYA
a122397b4b Merge branch '3.x' 2020-12-29 18:37:45 +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
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
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