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
18,038 Commits 2 Branches 219 Tags 163 MiB
70bc61f0f3
Commit Graph

18038 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Juan Luis Cano Rodríguez
70bc61f0f3 Include explanation about doctests 2021-09-06 16:38:18 +02:00
Juan Luis Cano Rodríguez
878478e725 Simplify doctest section 2021-09-06 16:35:00 +02:00
Juan Luis Cano Rodríguez
d505635224
Be more explicit on automatic xref generation 
Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
 2021-09-06 16:29:43 +02:00
Juan Luis Cano Rodríguez
da93cfc07f Reword primary domains 2021-09-06 16:26:03 +02:00
Juan Luis Cano Rodríguez
722629b35b Rephrase explanation on square brackets 2021-09-06 14:58:18 +02:00
Juan Luis Cano Rodríguez
c721d1746a
Style improvement 
Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
 2021-09-06 14:36:25 +02:00
Juan Luis Cano Rodríguez
a606db01f1 Add section on autosummary 2021-08-12 20:09:50 +02:00
Juan Luis Cano Rodríguez
8573c281ec Add section on automatic documentation generation 2021-08-12 20:09:50 +02:00
Juan Luis Cano Rodríguez
8334fd983e Add section on doctests 2021-08-12 20:09:50 +02:00
Juan Luis Cano Rodríguez
a5c684510e Add section on Python code preparation 2021-08-12 20:06:56 +02:00
Juan Luis Cano Rodríguez
2c1fa831c1 Add tutorial section on documenting Python objects 2021-08-12 20:06:56 +02:00
Juan Luis Cano Rodríguez
1a1e45f1af Add cross reference to role definitions 2021-08-12 20:06:56 +02:00
Takeshi KOMIYA
1acdf4f873
Merge pull request #9540 from astrojuanlu/new-tutorial-split 
Split tutorial in several files
 2021-08-13 01:38:28 +09:00
Takeshi KOMIYA
950d3db8d4
Merge pull request #9542 from tk0miya/fix_typehints 
refactor: Fix typehint for HTMLBuilder.css_files
 2021-08-13 01:36:36 +09:00
Takeshi KOMIYA
f518796086 refactor: Fix typehint for HTMLBuilder.css_files 2021-08-12 02:01:43 +09:00
Juan Luis Cano Rodríguez
f152680bfb Split tutorial in several files 2021-08-11 13:31:47 +02:00
Takeshi KOMIYA
c66b3ad519
Merge pull request #9530 from tacaswell/fix_numpy_class_attribute 
FIX: do not try to compute the boolean value of a numpy array
 2021-08-11 02:18:23 +09:00
Takeshi KOMIYA
8948f45226
Merge pull request #9527 from tk0miya/9525_tutorial 
Fix #9525: tutorial: Wrong condition in recipe.py
 2021-08-11 02:14:12 +09:00
Takeshi KOMIYA
52753e83e6
Merge pull request #9528 from jhcole/typo 
Fix typo
 2021-08-11 02:13:06 +09:00
Takeshi KOMIYA
97cd10d4d7
Merge pull request #9532 from sphinx-doc/bot/pull-translations 
Update message catalogs
 2021-08-11 02:12:30 +09:00
Takeshi KOMIYA
75c86c3059 Merge branch '4.1.x' into 4.x 2021-08-11 02:10:49 +09:00
Takeshi KOMIYA
e3a8ee9fcf
Merge pull request #9538 from tk0miya/9537_GenericAlias 
Fix #9537: autodoc: Some typing.* objects are broken
 2021-08-11 02:10:31 +09:00
Takeshi KOMIYA
648af37d86 Fix #9537: autodoc: Some typing.* objects are broken 
At the HEAD of 3.10, the implementation of `typing._GenericAlias` has
been changed to have correct _name and __name__.
 2021-08-11 01:59:38 +09:00
tk0miya
751fa265f1 Update message catalogs 2021-08-08 00:09:04 +00:00
Thomas A Caswell
2232d9430c
FIX: do not try to compute the boolean value of a numpy array 
If there is a numpy array as a class attribute, then `bool(meth)` will
raise.
 2021-08-06 11:00:00 -04:00
John Cole
8dbef8798a Fix typo 2021-08-04 20:28:45 -04:00
Takeshi KOMIYA
a7ac325a1b Update CHANGES for PR #9522 2021-08-05 01:54:28 +09:00
Takeshi KOMIYA
6ac326e019
Merge pull request #9522 from Gobot1234/4.x 
Recursively resolve PEP 585 builtins in restify
 2021-08-05 01:52:52 +09:00
Takeshi KOMIYA
c1692faba7 Fix #9525: tutorial: Wrong condition in recipe.py 2021-08-05 01:38:58 +09:00
James
596ad5523d
Merge branch '4.x' into 4.x 2021-08-02 00:32:14 +01:00
James
423b10a848
Add some tests 2021-08-02 00:20:08 +01:00
James
15fb9c64bf
Appease linter 2021-08-01 19:08:38 +01:00
James
d480447cc6
Match formatting of other recursive types 2021-08-01 19:01:55 +01:00
James
a30f2b99c3
Recursively resolve PEP 585 builtins 2021-08-01 18:53:00 +01:00
Takeshi KOMIYA
d788e78a5e Update CHANGES for PR #9447 2021-08-02 02:10:46 +09:00
Takeshi KOMIYA
641174db5d
Merge pull request #9447 from Blendify/Blendify/html-templates-sphinx-version 
HTML Templates: Expose full sphinx version tuple
 2021-08-02 02:08:50 +09:00
Takeshi KOMIYA
efea26f7d1
Merge pull request #9495 from tk0miya/9456_abbr_marks_on_search_result 
Fix #9456: html search: abbreation marks are inserted to the search
 2021-08-02 01:35:35 +09:00
Takeshi KOMIYA
3fe01c3c4a
Merge pull request #9507 from tk0miya/9479_autodoc_mocked_target 
Fix #9479: autodoc: Emit a warning if target is a mocked object
 2021-08-02 01:35:08 +09:00
Takeshi KOMIYA
33f70bea87
Merge branch '4.x' into 9479_autodoc_mocked_target 2021-08-02 00:28:15 +09:00
Takeshi KOMIYA
383eff0ced Update CHANGES for PR #9518 2021-08-02 00:27:18 +09:00
Takeshi KOMIYA
1cdde3df18
Merge pull request #9518 from jbms/fix-autodoc-docstring-signature-for-init-and-new 
Fix autodoc_docstring_signature support for __init__ and __new__
 2021-08-02 00:25:39 +09:00
Takeshi KOMIYA
f31d72c367 Update CHANGES for PR #9509 2021-08-01 16:18:57 +09:00
Takeshi KOMIYA
650730d9b2
Merge pull request #9515 from tk0miya/9504_SpecialForm 
Fix #9504: autodoc: generate incorrect reference to the parent class
 2021-08-01 15:13:27 +09:00
Takeshi KOMIYA
585869ac59 Merge branch '4.x' into 9479_autodoc_mocked_target 2021-08-01 15:12:37 +09:00
Takeshi KOMIYA
816f0746fe
Merge pull request #9519 from sphinx-doc/bot/pull-translations 
Update message catalogs
 2021-08-01 12:03:38 +09:00
tk0miya
531a7363c9 Update message catalogs 2021-08-01 00:09:22 +00:00
Takayuki SHIMIZUKAWA
723069d42b
fix issue template "How to Reproduce" doesn't render correctly 
remove unnecesary help-text in "value" instead of "description"
 2021-08-01 05:36:47 +09:00
Jeremy Maitin-Shepard
6c969ac87e Fix autodoc_docstring_signature support for __init__ and __new__ 
The `MethodDocumenter.get_doc` method added by
51ae283a38 prevents
DocstringSignatureMixin from working correctly for __init__ and
__new__ methods.  Additionally, the __new__ docstring was not obtained
correctly.

This commit checks for `self._new_docstrings` being set, and also
corrects the logic for obtaining the __new__ docstring.

There still remains the issue that when the class signature is
obtained from the signature of __init__ or __new__, only the real
signature is used, due to the use of `sphinx.util.inspect.signature`;
the autodoc_docstring_signature option does not have any effect.
 2021-07-31 09:32:40 -07:00
Takeshi KOMIYA
155ca3e853 Update CHANGES for PR #9509 2021-07-31 02:44:05 +09:00
Takeshi KOMIYA
e344c3b718
Merge pull request #9509 from yanyongyu/bugfix/get-type-hints 
[autodoc] Fix uncatched exception in get type hints
 2021-07-31 02:41:34 +09:00