Takeshi KOMIYA
fb2f777079
Close #3610 : autodoc: Support overloaded functions
2020-05-31 23:59:32 +09:00
Takeshi KOMIYA
3c5a9442c2
Merge branch '3.x' into 4422_support_GenericAlias
2020-05-31 14:49:13 +09:00
Takeshi KOMIYA
e20f29e325
Add sphinx.util.inspect:isgenericalias()
2020-05-30 21:06:54 +09:00
Takeshi KOMIYA
800dcf0f0a
Close #2106 : autodoc: Support multiple signatures on docstring
2020-05-30 15:40:21 +09:00
Eric Wieser
d229b120ad
Fix autoclass signature parsing
...
This fixes:
* Signatures defined by __new__
* Signatures defined by metaclasses
* Signatures defined by builtin base classes
All of these changes bring the sphinx docs inline with the behavior of `inspect.signature`.
Note that this changes autodoc to output `.. py:class: MyClass()` with parentheses even if no user-defined __init__ is present.
This is quite deliberate, as if no user-defined `__init__` is present the default is `object.__init__`, which indeed does not take arguments.
2020-05-28 08:36:56 +01:00
Takeshi KOMIYA
a5e3b4a43d
Fix #3673 : autodoc: bysource order does not work for a module having __all__
2020-05-23 21:52:11 +09:00
Takeshi KOMIYA
784d4cb36a
Fix #7685 : autosummary: imported members are listed unexpectedly
2020-05-21 01:24:46 +09:00
Daniel Fremont
de4aca857c
revisions per comments from tk0miya
2020-05-17 09:07:11 -07:00
Takeshi KOMIYA
3a81ffa79a
Fix #7650 : autodoc: undecorated signature is shown for decorated functions
2020-05-11 01:11:12 +09:00
Kjell Braden
db72c18cf9
add testcase for complex typehintsext.autodoc.typehints
2020-05-10 20:46:29 +09:00
Takeshi KOMIYA
6c65327be7
Merge pull request #7624 from tk0miya/refactor_autodoc2
...
refactor: autodoc: class processors on autofunction is no longer needed
2020-05-09 18:10:55 +09:00
Takeshi KOMIYA
c4d4ba2835
Fix #7551 : autosummary: a nested class is indexed as non-nested class
2020-05-07 01:57:46 +09:00
Takeshi KOMIYA
24fe05f14f
refactor: autodoc: class processors on autofunction is no longer needed
2020-05-07 01:55:33 +09:00
Takeshi KOMIYA
54bb1f3e62
refactor: test: Pass language_level to cython explicitly
2020-05-04 00:23:06 +09:00
Takeshi KOMIYA
9256daaa77
Merge branch '3.x' into 6857_enum_classmethod
2020-05-02 01:48:01 +09:00
Takeshi KOMIYA
25fc47e6b7
Fix #7559 : autodoc: misdetects a sync function is async
2020-05-01 22:05:45 +09:00
Takeshi KOMIYA
d612ef8f0b
Fix #6857 : autodoc: failed to detect a classmethod on Enum class
2020-04-30 22:54:49 +09:00
Takeshi KOMIYA
0bf9011509
Fix #7570 : autosummary: template option is broken
2020-04-30 00:14:59 +09:00
Takeshi KOMIYA
767864b0f1
Close #7143 : autodoc: Support final classes and methods
2020-04-28 01:24:41 +09:00
Takeshi KOMIYA
7888600f96
Merge pull request #7564 from eric-wieser/fix-missing-__annotations__
...
autodoc: Fix a logic error that causes annotations not to be shown for descriptors
2020-04-27 21:54:17 +09:00
Eric Wieser
b7ce4a4c13
Fix a logic error that causes annotations not to be shown for descriptors
...
This `if not self._datadescriptor` was originally here before type annotations were supported, to prevent showing `descr4 = <_Descriptor ...>` in the docs.
When type annotations were added, the support for appending `:type:` was put in the wrong place.
It should have been outside this if, not within it.
2020-04-27 12:57:39 +01:00
Takeshi KOMIYA
4eafda8588
Merge pull request #7546 from tk0miya/4030_autosummary_context
...
Close #4030 : autosummary: Add autosummary_context
2020-04-27 02:01:34 +09:00
Takeshi KOMIYA
037fe96dc1
Close #4030 : autosummary: Add autosummary_context
2020-04-25 11:15:43 +09:00
Jakob Lykke Andersen
abe65423ca
C, allow semicolon in the end of declarations
...
(except macros)
2020-04-24 11:38:22 +02:00
Jakob Lykke Andersen
ef0c2bf83c
C++, semicolon, move it entirely to ASTDeclaration
2020-04-24 10:57:23 +02:00
Takeshi KOMIYA
c9e4945623
Merge pull request #7473 from eric-wieser/meta-public
...
Add support for :meta public:
2020-04-23 02:15:42 +09:00
Takeshi KOMIYA
cc6ba63f5e
test: Remove meaningless testcases
2020-04-22 00:23:37 +09:00
Takeshi KOMIYA
b9da9237bc
Merge branch '3.x' into 6040_autosummary_recursive
2020-04-21 23:04:38 +09:00
Takeshi KOMIYA
476b73b6ca
autosummary: Add :recursive: option to autosummary directive
2020-04-21 22:47:00 +09:00
Takeshi KOMIYA
12cb90c3fa
Merge pull request #7492 from tk0miya/7490_autosummary_caption
...
Close #7490 : autosummary: Add ``:caption:`` option to autosummary directive
2020-04-20 00:52:45 +09:00
Takeshi KOMIYA
66744c656e
Merge pull request #7413 from tk0miya/papersize_for_latex_theme
...
LaTeX: Allow to override papersize and pointsize from LaTeX themes
2020-04-20 00:49:17 +09:00
Takeshi KOMIYA
21341f4b6c
Merge branch '3.0.x' into 3.x
2020-04-18 21:02:47 +09:00
Takeshi KOMIYA
ffb1ca3aaa
test: Add a docstring to avoid an error on py39a5+
2020-04-18 20:28:31 +09:00
Takeshi KOMIYA
dc46897768
Close #7490 : autosummary: Add `:caption:
` option to autosummary directive
2020-04-16 23:04:57 +09:00
Eric Wieser
0d7451c23d
Add support for :meta public:
...
A common use case for this is a class like `namedtuple`, which has a public `_replace` method that is so-named in order not to conflict with arbitrary user-provided attributes.
Rejected spellings include:
* `:meta not-private:`
* `:meta private: False`
2020-04-14 08:41:45 +01:00
Jakob Lykke Andersen
bbc7b6cc54
C, add scoping directives
2020-04-12 14:13:54 +02:00
Takeshi KOMIYA
1ca0b7ab62
LaTeX: Allow to override papersize and pointsize from LaTeX themes
2020-04-12 15:30:45 +09:00
Takeshi KOMIYA
231d75b0d0
Merge branch '2.x' into 3.0.x
2020-04-05 23:03:35 +09:00
Takeshi KOMIYA
360efdefec
Fix #7355 : autodoc: a signature of cython-function is not recognized well
2020-03-31 21:14:08 +09:00
Jakob Lykke Andersen
67e5edde6d
C, C++, do not recurse in anon symbols on addition
2020-03-25 20:07:16 +01:00
Takeshi KOMIYA
dd70d9faac
Fix #7331 : autodoc: a cython-method is not recognized as a method
2020-03-22 23:13:49 +09:00
Takeshi KOMIYA
5c396b6325
Fix #7331 : autodoc: a cython-function is not recognized as a function
2020-03-22 23:13:49 +09:00
Jakob Lykke Andersen
088f26278f
Add C++ test for backslash stripping
2020-03-20 13:26:51 +01:00
Jakob Lykke Andersen
04efdfa917
C, style decl specifiers as intented
2020-03-15 19:54:43 +01:00
Jakob Lykke Andersen
fdc55201c8
C, add __int64 as a fundamental type
2020-03-15 19:49:16 +01:00
Jakob Lykke Andersen
b2ca906830
C, add expression parsing and expr role
2020-03-15 19:49:16 +01:00
Jakob Lykke Andersen
815a9c657d
C, add new directives, fix xref lookup
2020-03-15 19:49:16 +01:00
Jakob Lykke Andersen
0f49e30c51
C, initial rewrite
2020-03-15 19:49:16 +01:00
Takeshi KOMIYA
a0bef9a86d
Merge pull request #7142 from septatrix/html-auxiliary-pygments-style
...
Add option for auxiliary pygments styles
2020-03-15 22:20:44 +09:00
Antony Lee
f9048cf18e
Handle singledispatch functions with rewritten signatures.
...
If a singledispatch function has its `__signature__` rewritten, autodoc
fails to annotate that signature because `func.__annotations__` is not
consulted. Instead, directly assign to `__signature__` instead.
2020-03-14 22:52:45 +01:00
Septatrix
f655835338
Fix tests
2020-03-14 19:46:37 +01:00
Septatrix
81fe5f8477
Remove html_pygments_dark_style option
2020-03-14 18:46:02 +01:00
Takeshi KOMIYA
372813a137
Merge pull request #7262 from tk0miya/testcase_for_py
...
test: Add testcase for special case of PythonDomain.find_obj()
2020-03-07 23:18:07 +09:00
Takeshi KOMIYA
8f7cc26b20
autodoc: Support singledispatch methods
2020-03-07 17:50:10 +09:00
Takeshi KOMIYA
961b4d1545
Close #2815 : autodoc: Support singledispatch functions
2020-03-07 17:50:10 +09:00
Takeshi KOMIYA
d7cab2ebfa
test: Add testcase for special case of PythonDomain.find_obj()
2020-03-07 02:18:10 +09:00
Takeshi KOMIYA
cdbefb600f
Support user defined LaTeX themes
2020-03-06 22:11:25 +09:00
Takeshi KOMIYA
34057601f4
Close #7165 : autodoc: Support Annotated type (PEP-593)
2020-03-03 00:14:24 +09:00
Terence D. Honles
90de551d4c
Fix: autodoc: __wrapped__
functions are not documented correctly
...
Functions that are decorated with `@lru_cache` or other `functools`
decorators may not even be detected as a function. This results in the
documentation not having the `()` or even trying to render the function
signature.
This change updates the `sphinx.util.inspect` code to unwrap
`__wrapped__` functions before determining if they can be documented.
`@lru_cache` and its associated test is an example of a decorated
function that is incorrectly identified as an attribute rather than a
module level function and when rendering the signature (upon changing
`isattributedescriptor`) the decorated function is still incorrectly
identified as a C function.
This change also renames the newly introduced `unwrap` as `unwrap_all`
because it is different than the prexisting Python supplied
`inspect.unwrap`.
See `update_wrapper` "Changed in version 3.4" for more background:
https://docs.python.org/3/library/functools.html#functools.update_wrapper
2020-02-27 16:27:41 -08:00
Takeshi KOMIYA
754d04f80d
Merge branch '2.4.x' into 3.x
2020-02-22 19:22:31 +09:00
Takeshi KOMIYA
b162273962
Merge pull request #7064 from tk0miya/7025_nosearch
...
Close #7025 : html search: full text search can be disabled via metadata
2020-02-22 17:53:01 +09:00
Takeshi KOMIYA
30b0361f9c
Close #7025 : html search: full text search can be disabled via metadata
2020-02-22 17:34:44 +09:00
Takeshi KOMIYA
2fec37219f
Fix #7189 : autodoc: classmethod coroutines are not detected
2020-02-22 00:49:45 +09:00
Takeshi KOMIYA
a033d53c24
Close #7032 : html_scaled_image_link is disabled for individual image
2020-02-18 01:48:11 +09:00
Takeshi KOMIYA
954db2bd27
Merge branch '2.0'
2020-02-16 21:42:20 +09:00
Takeshi KOMIYA
b80c7cd234
Merge pull request #7152 from gpotter2/elipsispatch
...
Fix #7146 : support (...) in type hint comments (V2)
2020-02-16 20:35:40 +09:00
Takeshi KOMIYA
cd8f3a78d9
Fix #7156 : autodoc: separator for keyword only arguments is not shown
2020-02-16 01:37:23 +09:00
gpotter2
51b80ab121
Fix #7146
2020-02-14 16:12:12 +00:00
Takeshi KOMIYA
c5f0025ed9
Merge branch 'master' into 5637
2020-02-12 01:42:05 +09:00
Takeshi KOMIYA
2737691212
pretty style fix
2020-02-12 01:39:13 +09:00
Takeshi KOMIYA
6e0119526a
Merge branch '2.0'
2020-02-09 16:21:32 +09:00
Takeshi KOMIYA
a17ad5cd39
Merge branch '2.3.2' into 2.0
2020-02-09 15:29:10 +09:00
Takeshi KOMIYA
2e87ee85a2
Merge branch '2.0'
2020-02-09 00:57:53 +09:00
Takeshi KOMIYA
13ca2323a9
Fix #7095 : dirhtml: Cross references are broken via intersphinx and :doc:
2020-02-07 23:32:27 +09:00
Takeshi KOMIYA
ecf7307023
Merge branch '2.0' into 6785_attr_can_refer_props
2020-02-06 22:30:50 +09:00
Takeshi KOMIYA
92cb828f14
autodoc: Support type_comment styled type annotation for variables
2020-02-03 01:19:05 +09:00
Takeshi KOMIYA
0258394d0b
Merge branch '2.0' into 6785_attr_can_refer_props
2020-01-30 23:32:05 +09:00
Takeshi KOMIYA
e7a0af807a
Merge branch '2.0'
2020-01-30 23:29:32 +09:00
Takeshi KOMIYA
67fefcc6f9
Merge branch '2.0' into 6418_autodoc_typehints_description
2020-01-30 23:19:45 +09:00
Jakob Lykke Andersen
3231b84827
C++, suppress some warnings that can never be fixed
2020-01-26 14:19:14 +01:00
Takeshi KOMIYA
dcd8f41a77
Add testcase for instance variables without defaults
2020-01-26 01:25:35 +09:00
Jakob Lykke Andersen
82a465c3b6
Merge pull request #7053 from jakobandersen/productionlist
...
Production list scoping and line continuation
2020-01-25 17:18:04 +01:00
Jakob Lykke Andersen
9fa23615ec
Fixes from review
2020-01-25 17:02:59 +01:00
Jakob Lykke Andersen
84bd44d04a
C++, fix cross references in compound directives
...
Fixes sphinx-doc/sphinx#5078
2020-01-25 11:43:26 +01:00
Jakob Lykke Andersen
80e08fe8fa
C++, make lookup key point to correct overloads
2020-01-25 11:42:49 +01:00
Takeshi KOMIYA
5397664d42
Add a new extension: sphinx.ext.autodoc.typehints
2020-01-25 17:56:39 +09:00
Takeshi KOMIYA
33fcd393ab
Fix #6785 : py domain: :py:attr: is able to refer properties again
2020-01-25 13:55:27 +09:00
Takeshi KOMIYA
ecf38edb43
Close #7051 : autodoc: Support instance variables without defaults (PEP-526)
2020-01-25 00:57:36 +09:00
Jakob Lykke Andersen
bcbb167b0d
Add backslash line continuation to productionlist
...
Fixes sphinx-doc/sphinx#1027
2020-01-22 22:51:22 +01:00
Jakob Lykke Andersen
c084c3f124
Implement scoping for productionlist
...
Fixes sphinx-doc/sphinx#3077
2020-01-22 22:32:30 +01:00
Jakob Lykke Andersen
204564549c
Merge pull request #7038 from jakobandersen/cpp_role_target_checking
...
C++, test role target checks and fix two cases
2020-01-20 20:05:16 +01:00
Jakob Lykke Andersen
6d7ff482f6
C++, test role target checks and fix two cases
2020-01-20 19:40:00 +01:00
Takeshi KOMIYA
4e257a8084
Merge branch '2.0' into 7023_partial_listed_as_module_members
2020-01-19 23:09:46 +09:00
Takeshi KOMIYA
347e301727
Merge branch '2.0'
2020-01-19 22:47:02 +09:00
Takeshi KOMIYA
a1f6bbf800
Merge pull request #7031 from tk0miya/7023_nested_partial_functions_not_listed
...
#7023 : autodoc: nested partial functions are not listed
2020-01-19 15:49:52 +09:00
Takeshi KOMIYA
53e38ccc30
Fix #7023 : autodoc: partial functions are listed as module members
2020-01-19 15:22:09 +09:00
Takeshi KOMIYA
e908e43f67
Fix #7023 : autodoc: nested partial functions are not listed
2020-01-17 09:15:45 +09:00
Takeshi KOMIYA
7906a6871e
Add testcase a partialmethod not having docstring (refs: #7023 )
2020-01-17 09:11:59 +09:00
Takeshi KOMIYA
ffdfb6cb87
Close #2755 : autodoc: Support type_comment style annotation
...
Note: python3.8+ or typed_ast is required
2020-01-13 13:23:45 +09:00
Takeshi KOMIYA
9ed162921e
autodoc: Support Positional-Only Argument separator (PEP-570 compliant)
2020-01-11 02:32:33 +09:00
Takeshi KOMIYA
b968bb91e9
Close #6830 : autodoc: consider a member private if docstring has "private" metadata
2020-01-04 13:28:07 +09:00
Takeshi KOMIYA
0319faf8f1
Merge branch '2.0'
2020-01-01 14:40:39 +09:00
Takeshi KOMIYA
eaf495c3c4
A happy new year!
2020-01-01 14:27:43 +09:00
Takeshi KOMIYA
e628afd5cd
Merge branch '2.0'
2020-01-01 11:39:46 +09:00
Takeshi KOMIYA
18e25d680d
Close #6966 : graphviz: Support `:class:
` option
2019-12-27 22:38:10 +09:00
Takeshi KOMIYA
b6244736c4
Merge pull request #6907 from kpnr/patch-2
...
Non-ASCII & non utf-8 charset corruption fix
2019-12-27 01:25:50 +09:00
Takeshi KOMIYA
5640cf879f
Merge branch '2.0'
2019-12-22 18:47:30 +09:00
Takeshi KOMIYA
72fa75cb9a
Close #6837 : LaTeX: Support a nested table
2019-12-22 18:00:58 +09:00
hkm
1ca9dacbfe
Added test case for non ASCII & non UTF8 encoding Windows-1251 in test_pycode section
2019-12-15 21:47:57 +03:00
Takeshi KOMIYA
712c20a3d9
Merge branch '2.0'
2019-12-16 00:05:35 +09:00
jfbu
30b26dd6a1
LaTeX: avoid quotes and TeX ligature replacements in PDF output
...
Refs: #6890
The comma character is not TeX-escaped because it is frequent in general
text and escaping it would make the LaTeX output larger for only dealing
with the problem of the LaTeX-ligature of ,, into a single character.
And one there is problem with the commas in options to Verbatim from
PygmentsBridge.
The hyphen character is escaped (not in ids and URIs!) to
\sphinxhyphen{} for both Unicode and non-Unicode engines. This is needed
to work around hyperref transforming -- and --- from section titles into
EN DASH resp. EM DASH in PDF bookmarks.
https://github.com/latex3/hyperref/issues/112
Note to expert LaTeX users: if Sphinx latex user with xelatex has
- turned off Smart Quotes for some reason,
- but does want TeX ligatures and thus overrode Sphinx
latex_elements['fontenc'] default (since #6888 ) to this effect,
then this should be added to LaTeX preamble:
\def\sphinxhyphen#1{-}% (\protected is now not needed)
\let\sphinxhyphenforbookmarks\sphinxhyphen
2019-12-15 14:19:50 +01:00
Takeshi KOMIYA
7ec567b6d0
Merge branch '2.0'
2019-12-09 00:13:42 +09:00
jfbu
a0fe0aba1b
Update longtable latex template
2019-12-07 00:37:33 +01:00
Takeshi KOMIYA
15c266c445
Merge branch '2.0'
2019-11-30 21:52:42 +09:00
Takeshi KOMIYA
c65243325c
Merge branch '2.0' into 6798_autosummary_emits_skip_member_event
2019-11-21 00:45:57 +09:00
Takeshi KOMIYA
6644830941
Merge branch '2.0'
2019-11-17 14:24:04 +09:00
Takeshi KOMIYA
76c7e07e8d
Merge branch '2.0' into 4683_more_translatable_toctree
2019-11-17 01:32:25 +09:00
Takeshi KOMIYA
491b19d6bb
autosummary: Allows to document a member forcedly if skip-member handler returns False
2019-11-16 18:19:33 +09:00
Takeshi KOMIYA
66c3dd3adb
Close #6798 : autosummary: emit `autodoc-skip-member
` event on generating stub file
2019-11-16 18:19:31 +09:00
Jean-François B
b070e5be52
Merge branch '2.0' into 6738_new_escape_for_unicode_latex_engine
2019-11-15 19:09:16 +01:00
Takeshi KOMIYA
5aee836dc1
Close #4683 : i18n: make explicit titles in toctree translatable
2019-11-01 22:01:06 +09:00
Takeshi KOMIYA
56bbb08b2c
Do not replace unicode characters by LaTeX macros on unicode supported LaTeX engines
2019-10-20 22:54:21 +09:00
Takeshi KOMIYA
93d659568d
Fix #5070 : epub: Wrong internal href fragment links
2019-10-20 14:32:08 +09:00
jfbu
685e3fdb49
Merge branch '2.0'
2019-08-01 17:49:24 +02:00
Takeshi KOMIYA
a498960de9
Merge branch '2.0'
2019-07-13 11:17:35 +09:00
Takeshi KOMIYA
1c088ec163
Fix #6567 : autodoc: autodoc_inherit_docstrings does not effect to __init__()
2019-07-11 01:39:17 +09:00
woutdenolf
9dc9b8754d
Merge with master and address code review
2019-07-08 08:29:23 +02:00
Nathan Goldbaum
a570ea6c03
Fix #6545 . Strip doctests for doctest_node blocks.
2019-07-07 19:28:45 -04:00
Takeshi KOMIYA
95723aa6f6
Fix flake8 violations
2019-07-01 00:28:30 +09:00
Takeshi KOMIYA
852c061cc6
Merge pull request #6539 from tk0miya/fix_flake8_violations
...
Fix flake8 violations
2019-06-30 15:11:47 +09:00
Takeshi KOMIYA
8017b6ec2c
Fix flake8 violations
2019-06-30 14:55:22 +09:00
Takeshi KOMIYA
35b1b5c328
Fix #6512 : typo in continuation label for tables
2019-06-22 01:33:29 +09:00
Takeshi KOMIYA
b325a1de2b
Merge branch '2.0'
2019-06-21 12:47:02 +09:00
Takeshi KOMIYA
efc0c19142
Merge pull request #6449 from tk0miya/6444_non_existing_urls
...
Fix #6444 : test: replace example.com by existing page
2019-06-19 11:19:23 +09:00
Takeshi KOMIYA
5d42659e33
Merge branch '2.0'
2019-06-15 23:39:44 +09:00
Takeshi KOMIYA
e0eb86224d
Merge branch '2.1.1' into 2.0
2019-06-10 22:31:18 +09:00
Takeshi KOMIYA
21be789d4d
Revert "Fix #1063 : autodoc: automodule directive handles undocumented module level variables"
...
This reverts commit 69d93c967c
(without
CHANGES).
2019-06-10 21:40:11 +09:00
Takeshi KOMIYA
9f470cec6c
Merge branch '2.0'
2019-06-09 01:27:34 +09:00
Takeshi KOMIYA
9b2c1c679a
Fix #6444 : test: replace example.com by existing page
2019-06-05 23:42:24 +09:00
Takeshi KOMIYA
301102edff
Merge pull request #6439 from mitya57/reproducible-downloads
...
Make generated download links reproducible
2019-06-05 22:37:58 +09:00
Dmitry Shachnev
9df6e40145
Test that downloads with the same filename are still handled correctly
2019-06-03 20:00:14 +03:00
Takeshi KOMIYA
81e2e1d971
test: Update testcase for autoclass_content and autodoc_docstring_signature
2019-06-03 23:20:33 +09:00
Takeshi KOMIYA
f7851b62e0
test: Update testcase for autoclass_content
2019-06-03 23:20:33 +09:00
Takeshi KOMIYA
42e9fd896e
test: Move class inheritance samples into target.inheritance module
2019-06-03 22:34:33 +09:00
Takeshi KOMIYA
3f617a4a9b
test: Update testcase for between()
2019-06-03 01:16:20 +09:00
Takeshi KOMIYA
6cbee7de3c
test: Move descriptor example to independent file
2019-06-03 00:38:01 +09:00
woutdenolf
ec8656bd27
[autosummary] remove recursion limit and module/package separation
2019-06-02 16:26:40 +02:00
Takeshi KOMIYA
c4f44bdd22
Merge branch '2.0'
2019-06-02 21:17:38 +09:00
Takeshi KOMIYA
27dd8367c6
Merge pull request #6423 from tk0miya/1063_autodoc_undoc_module_variables
...
Fix #1063 : autodoc: automodule directive handles undocumented module level variables
2019-06-02 16:20:49 +09:00
Takeshi KOMIYA
5da74898c3
Merge branch '2.0'
2019-06-02 01:09:09 +09:00
Takeshi KOMIYA
4c19ab7058
Merge commit '54d5fcfaebc3364044761d30c0fed6bd4d3052c3'
2019-06-02 01:02:54 +09:00
Takeshi KOMIYA
91fceb4b5f
Merge branch '2.0.2' into 2.0
2019-06-02 00:58:46 +09:00
Takeshi KOMIYA
69d93c967c
Fix #1063 : autodoc: automodule directive handles undocumented module level variables
2019-06-01 23:18:37 +09:00
woutdenolf
140ae00baa
Merge branch 'master' into feature-autosummary-packages
2019-06-01 12:42:28 +02:00
Takeshi KOMIYA
e001d358d0
Add :force: option to code directives
2019-06-01 13:42:57 +09:00
Takeshi KOMIYA
ce3c5735cd
Merge branch '2.0'
2019-06-01 01:45:47 +09:00
Takeshi KOMIYA
b9d7239d90
Merge branch '2.0'
2019-05-29 00:51:25 +09:00
Takeshi KOMIYA
0ea380eddd
Close #6361 : autodoc: Add autodoc_typehints to suppress typehints from signature
2019-05-26 00:35:24 +09:00
Stefan Wallentowitz
ac0bb5132b
Fix latex figure in admonition
...
Using figures in an admonition produces a LaTeX error ("Not in outer
par mode."). This is because it generates a float in a float. This can
be trivially fixed by overwriting the alignment to H, which is also
what is most probably intended.
2019-05-24 16:07:13 +02:00
Takeshi KOMIYA
277aba935d
Close #6325 : autodoc: Support attributes in __slots__
2019-05-22 09:56:46 +09:00
Takeshi KOMIYA
557d8d140e
Merge pull request #6365 from tk0miya/refactor_py_domain
...
Add :abstractmethod: option to py:method directive and support abstractmethod by autodoc
2019-05-19 23:46:34 +09:00
woutdenolf
1a67b87910
Merge branch 'master' into feature-autosummary-packages
2019-05-18 14:42:34 +02:00
Adrián Chaves
e84ba7f78a
Support coverage_ignore_pyobjects in the coverage builder
2019-05-15 12:23:05 +02:00
Takeshi KOMIYA
e288999933
Close #744 : autodoc: Support abstractmethod
2019-05-15 00:01:00 +09:00
Takeshi KOMIYA
d290dfd7e9
Fix #6311 : autosummary: autosummary table gets confused by complex type hints
2019-05-12 14:53:25 +09:00
Takeshi KOMIYA
37a5736a1f
Merge branch '2.0'
2019-05-06 21:09:43 +09:00
Takeshi KOMIYA
a765c2e4ab
Add sphinx.util.inspect:iscoroutinefunction()
2019-04-23 01:40:37 +09:00
Takeshi KOMIYA
efc3405c6f
Merge branch '2.0'
2019-04-14 19:35:33 +09:00
Alex Sergeev
b7f6657dd1
Address feedback
2019-04-13 22:09:01 -10:00
Takeshi KOMIYA
4aecac8251
refactor: Move subject of inspection to rootdir
2019-04-13 22:48:49 +09:00
Takeshi KOMIYA
df05d9254d
Merge branch '2.0'
2019-04-07 19:29:52 +09:00
woutdenolf
6e0b0517c0
[autosummary] address code review
2019-04-07 12:00:57 +02:00
woutdenolf
4004dd5635
Merge branch 'master' into feature-autosummary-packages
2019-04-07 10:32:57 +02:00
Takeshi KOMIYA
6cb263b9c8
Merge pull request #6212 from tsanikgr/feature/autosummary_imported_members
...
Allow setting imported_members for autosummary in conf.py
2019-04-04 23:04:36 +09:00
Takeshi KOMIYA
61098a0ae2
Drop features and APIs deprecated in 1.8
2019-03-30 14:50:37 +09:00
tsanikgr
bec116a3b6
#5877 : Allow setting imported_members for autosummary in conf.py
2019-03-27 14:19:16 +00:00
Takeshi KOMIYA
9fe962c208
Drop tests for deprecated modules
2019-03-24 21:46:31 +09:00
Takeshi KOMIYA
86f0336693
Merge branch '2.0'
2019-03-21 02:21:59 +09:00
Takeshi KOMIYA
6698bd6b3f
Fix #6178 : i18n: Captions missing in translations for hidden TOCs
2019-03-17 17:19:33 +09:00
Takeshi KOMIYA
332dd5d89f
Merge branch '2.0'
2019-03-10 17:46:12 +09:00
Takeshi KOMIYA
4bac6b56d0
Merge branch '1.8' into 2.0
2019-03-10 16:52:51 +09:00
Takeshi KOMIYA
05d3e37ef7
Fix #6149 : LaTeX: :index: role titles causes build error of LaTeX
2019-03-10 02:07:02 +09:00
Takeshi KOMIYA
7c712464bb
Merge branch '2.0'
2019-03-09 18:12:56 +09:00
Takeshi KOMIYA
d7024fe996
Merge branch '1.8' into 2.0
2019-03-09 18:12:33 +09:00
Takeshi KOMIYA
f61a5f91f7
Fix test: imgconverter expects size of images fixed
2019-03-09 18:04:40 +09:00
Martin Packman
71dec3b38e
Fix UnboundLocalError when building changes
...
Split testing of changes builder to its own test file and root.
Improve coverage a little, and add case that fails if a module
directive is included in the rst source.
Correctly handle changesets with a module declared.
Fixes https://github.com/sphinx-doc/sphinx/issues/6134
2019-03-08 13:30:27 +00:00
Takeshi KOMIYA
01f46111c5
Merge branch '2.0'
2019-03-02 18:38:24 +09:00
Takeshi KOMIYA
ac9e9c0745
Merge branch '1.8' into 2.0
2019-03-02 18:37:20 +09:00
Brendt Wohlberg
5334d96213
Merge branch 'master' into master
2019-02-28 16:49:01 -08:00
Takeshi KOMIYA
9c2e7b6798
Fix #6067 : LaTeX: images having a target are not aligned even if specified
2019-02-28 02:05:21 +09:00
Takeshi KOMIYA
6c244bdd69
Fix #6067 : LaTeX: images having a target are concatenated to next line
2019-02-28 02:04:12 +09:00
Takeshi KOMIYA
fb8838ee53
refactor: Use CatalogRepository instead of find_catalog_source_file()
2019-02-27 22:47:08 +09:00
Takeshi KOMIYA
2745f1e156
Merge pull request #5508 from jdknight/bugfix/allow-applying-linenos-with-post-transform
...
directive-code: do not force linenos value on run
2019-02-24 20:37:22 +09:00
woutdenolf
33e7b76c32
Merge branch 'master' into feature-autosummary-packages
2019-02-24 12:16:52 +01:00
woutdenolf
2a7d6081d9
[autosummary] test package recursion
2019-02-24 12:13:04 +01:00
Takeshi KOMIYA
8a391d1781
Merge branch '1.8'
2019-02-17 22:37:23 +09:00
Takeshi KOMIYA
08cd23a0bb
Fix #6047 : autodoc: `autofunction
` emits a warning for method objects
2019-02-17 18:23:14 +09:00
James Knight
3858a62814
test: verify linenothreshold usage
...
Adding a unit test to verify the use of the `linenothreshold` option
provided by the `highlight` directive [1]. The included document to test
will introduce two sets of `code-block` and `literalinclude` directives
where the first entry generates contents using line numbers and the
second entry generates contents not using line numbers, respectfully.
[1]: https://github.com/sphinx-doc/sphinx/blob/v1.8.4/sphinx/transforms/post_transforms/code.py#L85
Signed-off-by: James Knight <james.d.knight@live.com>
2019-02-16 22:14:30 -05:00
Takeshi KOMIYA
5437ab61e9
Merge pull request #6074 from tk0miya/1148_autodecorator
...
Closes #1148 : autodoc: Add autodecorator directive for decorators
2019-02-16 21:45:36 +09:00
Takeshi KOMIYA
1660269d01
Fix a test
2019-02-16 01:55:58 +09:00
Takeshi KOMIYA
686486498c
Closes #1148 : autodoc: Add autodecorator directive for decorators
2019-02-15 02:14:38 +09:00
Takeshi KOMIYA
3b49f9fe3d
Separate htmlhelp to sphinxcontrib package
2019-02-15 01:44:32 +09:00
Takeshi KOMIYA
cd542fb2af
Merge pull request #6061 from tk0miya/reduce_warnings_of_rootcase
...
test: Reduce warnings on building test-root
2019-02-14 22:24:27 +09:00
Takeshi KOMIYA
9afe93d8f6
refactor: test: Remove unused settings from conf.py
2019-02-14 02:21:07 +09:00
Takeshi KOMIYA
891178e8ed
test: Reduce warnings on building test-root
...
Note: all warnings are tested on test-warnings.
2019-02-14 02:20:55 +09:00
Takeshi KOMIYA
550c88f98c
Merge pull request #6064 from tk0miya/5636_add_autosummary_mock_imports
...
Closes #5635 : autosummary: Add autosummary_mock_imports to mock external libraries
2019-02-14 01:13:04 +09:00
Takeshi KOMIYA
73b8d6ff33
Closes #5636 : autosummary: Add autosummary_mock_imports to mock external libraries
2019-02-11 23:19:25 +09:00
Takeshi KOMIYA
ac399b3b4e
refactor tests for autosectionlabel
2019-02-11 18:34:04 +09:00
Takeshi KOMIYA
7770940af8
Merge branch 'master' into 4261_autosectionlabel_max_depth
2019-02-11 17:53:50 +09:00
Takeshi KOMIYA
11a398b1b0
Merge pull request #6052 from tk0miya/5394_meaningful_annotations_for_mock
...
Display meaningful names in type annotations for mocked objects
2019-02-11 12:32:45 +09:00
Takeshi KOMIYA
8812131a57
Merge pull request #6022 from tk0miya/5196_linkcheck_should_check_remote_image
...
Close #5196 : linkcheck also checks remote images exist
2019-02-11 02:05:14 +09:00
Takeshi KOMIYA
a6ef8190ce
Add testcase for mocked objects in autodoc
2019-02-11 01:46:38 +09:00
Takeshi KOMIYA
3a237f7f4d
Merge pull request #6017 from tk0miya/4550_align_figures_to_center
...
Close #4550 : All tables and figures without ``align`` option are displayed to center
2019-02-10 20:54:24 +09:00
Takeshi KOMIYA
7415f64eab
refactor: htmlhelp: Generate .hhc file from template
2019-02-09 14:56:51 +09:00
Takeshi KOMIYA
1d5e3cba0e
refactor: test-docutilsconf
...
Use options for reST parser instead of HTML4 writer's.
2019-02-09 00:49:49 +09:00
woutdenolf
4365c8436f
[autosummary] tests for autosummary modules and packages
2019-02-08 16:11:29 +01:00
Takeshi KOMIYA
25027945f5
Close #4550 : All tables and figures without `align
` option are displayed to center
2019-02-08 01:39:41 +09:00
Takeshi KOMIYA
500bf85443
Merge branch 'master' into 5196_linkcheck_should_check_remote_image
2019-02-08 00:10:14 +09:00
Jean-François B
ed86ada661
Merge pull request #5992 from jfbu/latex_safe_graphics
...
LaTeX: safer image inclusion
2019-02-05 18:03:07 +01:00
jfbu
0d72052141
Merge branch 'master' into latex_safe_graphics
2019-02-05 17:46:00 +01:00
Takeshi KOMIYA
ff80d2f538
Merge pull request #5983 from tk0miya/separate_applehelp
...
Separate applehelp to sphinxcontrib package
2019-02-06 01:14:02 +09:00
Takeshi KOMIYA
c4397318d3
Separate applehelp to sphinxcontrib package
2019-02-06 00:44:37 +09:00
Takeshi KOMIYA
20edbe9500
Merge pull request #6015 from tk0miya/1851_omit_argument_for_code-block
...
Close #1851 : Allow to omit an argument for code-block directive
2019-02-06 00:24:17 +09:00
Takeshi KOMIYA
f551915e9f
Close #5196 : linkcheck also checks remote images exist
2019-02-06 00:21:52 +09:00
Takeshi KOMIYA
d1cd72660b
Merge pull request #6012 from tk0miya/update_svgimg
...
Fix test: imgconverter expects size of images fixed
2019-02-04 01:53:34 +09:00
Takeshi KOMIYA
6ca669295c
Close #1851 : Allow to omit an argument for code-block directive
2019-02-04 01:50:44 +09:00
Takeshi KOMIYA
21fef75c3b
Fix test: imgconverter expects size of images fixed
2019-02-03 23:59:15 +09:00
Takeshi KOMIYA
622a678377
Merge pull request #6010 from tk0miya/4611_show_warnings_for_duplicated_toctree
...
Fix #4611 : epub: Show warning for duplicated ToC entries
2019-02-03 23:36:43 +09:00
Takeshi KOMIYA
b40ad9ffd4
Merge branch '1.8'
2019-02-03 23:20:26 +09:00
Takeshi KOMIYA
b950480218
Fix #4611 : epub: Show warning for duplicated ToC entries
2019-02-03 22:53:30 +09:00
Takeshi KOMIYA
b7c679626a
Fix #5948 : LaTeX: duplicated labels are generated for sections
2019-02-03 22:33:24 +09:00
Takeshi KOMIYA
c70dfcd390
Merge branch '1.8'
2019-02-03 19:53:12 +09:00
Takeshi KOMIYA
ed3d13b939
Merge pull request #6009 from tk0miya/4611_add_testcase_for_html_style
...
Separate testcase for html_style to single case from root
2019-02-03 19:48:56 +09:00
Takeshi KOMIYA
705248af2f
Merge branch '1.8'
2019-02-03 19:33:28 +09:00
Takeshi KOMIYA
97782c8ba1
Separate testcase for html_style to single case from root
2019-02-03 19:16:04 +09:00
Takeshi KOMIYA
36e770fe68
test: Replace SVG image by simple one
...
Old SVG image contains non standard tags and attributes. Therefore,
epubcheck warns it as invalid. To avoid the warnings, this replaces it
by very simple one.
2019-02-03 19:08:28 +09:00
jfbu
669f9c3a13
LaTeX: safer image inclusion
...
Closes : #5956
2019-01-29 11:15:49 +01:00
Takeshi KOMIYA
20bf74c637
Separate jsmath to sphinxcontrib package
2019-01-13 14:07:12 +09:00
Takeshi KOMIYA
68c90a26f1
quickstart: Simplify generated conf.py (for latex)
2019-01-07 23:06:14 +09:00
Takeshi KOMIYA
114ff77f68
test: Omit master_doc settings from testcases
2019-01-03 10:58:42 +09:00
Takeshi KOMIYA
5428d94d24
Remove coding magic comments from tests
2019-01-02 21:53:07 +09:00
Takeshi KOMIYA
76e9f57c2e
Merge branch '1.8'
2019-01-02 16:16:25 +09:00
Takeshi KOMIYA
1b1ebd2c75
A happy new year!
2019-01-02 16:00:30 +09:00
jfbu
32d57b8637
Merge branch '1.8'
...
resolved Conflicts:
doc/development/tutorials/todo.rst
sphinx/locale/__init__.py
sphinx/search/zh.py
2018-12-28 12:50:20 +01:00
Timotheus Kampik
221614654f
#5605 fix Chinese search index ( #5611 )
...
generate search index for Latin words correctly if search language is Chinese
2018-12-25 18:41:52 +01:00
Takeshi KOMIYA
4702086681
Merge branch '1.8'
2018-12-24 00:49:36 +09:00
animalize
cedd94c541
[1.8] htmlhelp: convert hex escaping to decimal escaping in .hhc/.hhk files ( #5853 )
...
* htmlhelp: convert hex escaping to decimal escaping in .hhc/.hhk files
.hhc/.hhk files don't recognize hex escaping, we need convert hex escaping to decimal escaping. for example: `'` -> `'`.
2018-12-23 22:39:12 +09:00
jfbu
701b39328f
Merge branch '1.8'
...
(Resolved) Conflicts:
sphinx/texinputs/sphinxmanual.cls
2018-12-23 11:23:04 +01:00
Takeshi KOMIYA
f06e84ac4f
Fix #5800 : todo: crashed if todo is defined in TextElement
2018-12-22 01:10:23 +09:00
Takeshi KOMIYA
5e5bdb8a64
Remove absolute_import
2018-12-17 20:47:49 +09:00