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,073 Commits 2 Branches 219 Tags
a843fd3db8b588be93b576049a8a291bc4b3ec9d
Commit Graph

3412 Commits

Author SHA1 Message Date
Takeshi KOMIYA
a8927bcd3e Merge branch '3.x' 2020-08-08 18:16:59 +09:00
Mateusz Lapsa-Malawski
2aa54e54f5 improve test_nosearch 2020-08-07 19:30:12 +01:00
Michal Čihař
1bf7fe424e i18n: Add support for having single text domain 
The gettext_compact can now be a string which is then a single domain
for all documents.

Fixes #784
 2020-08-07 20:22:30 +02:00
Mateusz Lapsa-Malawski
7aa52e658c update tests 2020-08-07 19:22:17 +01:00
Takeshi KOMIYA
88b2ec6c34 Fix #8041: autodoc: An ivar on super class is not shown unexpectedly 
An annotated instance variable on super class is not documented when
derived class has also other annotated instance variables because
`obj.__annotations__` is overrided by derived class's type hints.

To get annotations of the target class correctly, this scans MRO to
get all of annotated instance variables.
 2020-08-08 00:21:29 +09:00
Takeshi KOMIYA
a4996f9054 Fix #7780: napoleon: multiple params declaration was wrongly recognized 
So far, napoleon converts multiple paramaters declrarations to single
paramaeter fields (`:param:` and `:type:`) unexpectedly.  As a result,
the output seems broken.

This converts it to multiple parameter fields (a pair of field for each
parameter declration) to build parameter successfully.

Note: The conversion rule is available only when napoleon_use_params=True.
 2020-08-07 23:46:55 +09:00
Takeshi KOMIYA
99e65a59be napoleon: Fix a broken test (refs: #8049) 
Fix a testcase that added just before #8049 merged.
 2020-08-07 23:44:32 +09:00
Takeshi KOMIYA
62a6df8f3c Merge pull request #8049 from keewis/type-preprocessing-without-use_param 
enable type preprocessing without use_param
 2020-08-07 23:37:22 +09:00
Takeshi KOMIYA
64a26ff4de Merge pull request #7799 from keewis/escape-combined-args-kwargs 
Escape combined args kwargs
 2020-08-06 10:59:21 +09:00
Keewis
849d3c18a7 remove the syntax checks from the escape method and update the tests 2020-08-05 19:22:43 +02:00
Takeshi KOMIYA
784e7636d9 Merge pull request #8025 from tk0miya/6698_no-trim-flags 
Close #6698: doctest: Add :trim-flags: and :no-trim-flags: options
 2020-08-06 00:29:36 +09:00
Takeshi KOMIYA
059dc108ba Close #6698: doctest: Add :no-trim-doctest-flags: options 
To control trimming doctest flags manually, this adds new options
:trim-doctest-flags: and :no-trim-doctest-flags: to doctest
directives.  It helps to describes doctest module itself in python
doc (see #6698).
 2020-08-05 23:39:05 +09:00
Keewis
478ab44d7e Merge branch '3.x' into escape-combined-args-kwargs 2020-08-04 18:38:03 +02:00
Takeshi KOMIYA
fcf63a20cd Merge pull request #8021 from keewis/fix-type-preprocessor 
Fix type preprocessor
 2020-08-05 00:19:29 +09:00
Keewis
47da37e1d9 make sure strings are not split using other delimiters 2020-08-04 12:28:30 +02:00
Keewis
fbad78d08f check that a "default <obj>" notation works with xrefs 2020-08-04 12:21:00 +02:00
Keewis
cac6d1787d preprocess even with napoleon_use_param = False 2020-08-04 10:43:31 +02:00
Takeshi KOMIYA
c0157cf074 refactor: test: Rename target.enum to target.enums 
Using "enum" for module name bothers me on debugging errors because
it sometimes raises ImportError.
 2020-08-03 02:30:30 +09:00
Takeshi KOMIYA
57af828882 Merge pull request #8035 from tk0miya/8034_argument_for_private-members 
Close #8034: autodoc: :private-member: can take an list of member names
 2020-08-03 01:57:13 +09:00
Takeshi KOMIYA
5d301b44b9 Fix #8032: autodoc: A typehint for inherited ivars is not shown 
This tries to import the parent object for the instance attribute
to get type annotations for the variable.
 2020-08-02 18:27:03 +09:00
Takeshi KOMIYA
03a6028663 Merge pull request #8028 from tk0miya/8011_ivar_for_autosummary 
Close #8011: autosummary: Support instance attributes
 2020-08-02 18:24:32 +09:00
Jakob Lykke Andersen
89df9a18d2 Merge pull request #8037 from jakobandersen/cpp_template_nontype 
C++, fix non-type template parameter parsing
 2020-08-02 11:22:45 +02:00
Jakob Lykke Andersen
a99039b13b C++, fix non-type template parameter parsing 
Fixes sphinx-doc/sphinx#7944
 2020-08-02 10:34:51 +02:00
Takeshi KOMIYA
af15593c0c Close #7768: i18n: figure_language_filename supports {docpath} token 
To build structured i18n imaging directory, figure_language_filename
now supports `{docpath}` token that is a dirname of the current
document.
 2020-08-02 16:28:54 +09:00
Takeshi KOMIYA
d7a84e83cc Close #8034: autodoc: :private-member: can take an list of member names 
Now :private-member: option can take an explicit list of member names to
be documented as its arguments (like :special-members: does).
 2020-08-02 01:27:14 +09:00
Keewis
6be806b3c8 check that floats and complex numbers are detected as literals 2020-08-01 14:20:04 +02:00
Keewis
92e9cd488c use a regex to decide whether to postprocess a token starting with default 2020-08-01 13:38:38 +02:00
Keewis
3ff956c27a Merge branch '3.x' into fix-type-preprocessor 2020-08-01 13:26:11 +02:00
Takeshi KOMIYA
92e863fb24 Close #8011: autosummary: Support instance attributes 
This allows the autosummary directive to take instance attributes to
build documents for them.
 2020-08-01 19:19:18 +09:00
Takeshi KOMIYA
c14c00397e Merge branch '3.x' 2020-08-01 16:59:00 +09:00
Keewis
b353dfed7b properly link ... to Ellipsis 2020-07-31 17:44:04 +02:00
Keewis
31809b3041 add tests for referencing ellipsis objects 2020-07-29 22:30:02 +02:00
Keewis
e39c1a8d6a add more delimiters so describing mappings becomes possible 2020-07-29 22:29:03 +02:00
Keewis
05bf00bd4c make the postprocessing a bit more robust and add tests 2020-07-29 22:23:51 +02:00
Takeshi KOMIYA
a99675bf78 Fix #8008: py domain: failed to parse a type annotation containing ellipsis 
Fix _parse_annotation() does not support a type annotation having ellipsis.
 2020-07-30 01:48:25 +09:00
Keewis
0e5964dad9 move the misplaced GoogleDocstring test to the appropriate test class 2020-07-29 02:34:17 +02:00
Jakob Lykke Andersen
2cf3e7cae2 Merge pull request #8014 from jakobandersen/utzig-named-variadic-arg 
C, named variadic arg
 2020-07-27 19:51:17 +02:00
Jakob Lykke Andersen
1b3bf4e319 C, changelog and test for named variadic args 2020-07-27 19:42:58 +02:00
Keewis
58f84186e0 Merge branch '3.x' into escape-combined-args-kwargs 2020-07-25 15:15:06 +02:00
Takeshi KOMIYA
ac0a800265 Merge pull request #7690 from keewis/transform_numpy_parameter_types 
preprocessing numpy types
 2020-07-25 21:41:32 +09:00
Hameer Abbasi
98d3ed01ff Merge branch 'master' into mathjax-3 2020-07-24 16:58:55 +02:00
Takeshi KOMIYA
327c187284 Merge branch '3.x' 2020-07-24 23:49:45 +09:00
Hameer Abbasi
746cf3505c Merge branch 'master' into mathjax-3 2020-07-24 11:53:27 +02:00
Takeshi KOMIYA
da174138af Merge pull request #7927 from jnothman/name-case-clash 
Add autosummary_filename_map config to avoid clashes
 2020-07-24 01:07:19 +09:00
Joel Nothman
144f18a528 Remove irrelevant test RST 2020-07-23 17:27:57 +10:00
Keewis
ae35f81d3d allow mapping to a long name 2020-07-21 17:13:41 +02:00
Keewis
9b425606e7 support pandas-style default spec by postprocessing tokens 2020-07-21 12:26:28 +02:00
Takeshi KOMIYA
d8064a8b8f Merge pull request #7985 from tk0miya/5208_linkcheck_for_localfiles 
Close #5208: linkcheck: Support checks for local links
 2020-07-21 01:37:04 +09:00
Takeshi KOMIYA
d4863a80c0 Merge pull request #7984 from tk0miya/7983_Generator_annotation 
Fix #7983: autodoc: Generator type annotation is wrongly rendered in py36
 2020-07-20 01:00:04 +09:00
Takeshi KOMIYA
f95ba21f4a Close #5208: linkcheck: Support checks for local links 2020-07-19 19:08:14 +09:00