Matt from Documatt
db9375363c
Add link to third party themes on GitLab
...
GitLab, alternative to GitHub, also contains a lot of beautiful open source themes.
2020-08-07 14:46:19 +02:00
Keewis
79a2471032
add a create_documenter method wrapping get_documenter
2020-08-07 14:17:45 +02:00
Keewis
78e4499435
revert the dispatcher changes
2020-08-07 14:10:12 +02:00
Keewis
95c861facb
always use :obj: instead of searching the inventory
2020-08-07 12:44:22 +02:00
Keewis
75602f290a
make sure the roles are stripped from invalid names, too
2020-08-06 16:38:49 +02:00
Keewis
4428393403
translate the functions before attempting to find a matching role
2020-08-06 14:08:34 +02:00
Keewis
ca0bd28681
ignore the mypy error on possibly failing attribute lookup
2020-08-06 13:17:40 +02:00
Takeshi KOMIYA
e4e9a0f4be
Update CHANGES for PR #7799
2020-08-06 11:01:52 +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
Takeshi KOMIYA
9c55630018
Update CHANGES for PR #8048
2020-08-06 10:57:43 +09:00
Takeshi KOMIYA
a8032b4405
Merge pull request #8048 from cjmayo/graphviz
...
Don't copy graphviz.css when building man pages
2020-08-06 10:56:27 +09:00
Chris Mayo
71e9a15ccf
Don't copy graphviz.css when building man pages
...
_static/graphviz.css is being created alongside the man pages.
2020-08-05 20:05:49 +01:00
Takeshi KOMIYA
f743be0054
Merge pull request #8047 from cjmayo/typos
...
Assorted typos including sphinx-buid in internationalization figure
2020-08-06 02:38:07 +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
e79cd79cd2
revert the change to DocFieldTransformer
2020-08-05 14:28:32 +02:00
Keewis
e697242451
fix the tests by falling back to a empty dict on AttributeError
2020-08-04 20:50:02 +02:00
Keewis
e9f9da5326
Merge branch '3.x' into preprocess-other-sections
2020-08-04 19:33:28 +02: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
c812370427
expect the normal raises and yields to be preprocessed, too
2020-08-04 14:59:54 +02:00
Keewis
d9fb3bc25c
search the role for See Also items in the intersphinx inventory
2020-08-04 14:35:33 +02: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
af7d6a5be8
only allow "default <obj>" and "default: <obj>" for now
2020-08-04 12:20:09 +02:00
Keewis
cb61f0f734
document that we don't require use_param = True anymore
2020-08-04 11:39:48 +02:00
Keewis
2c75aaaa54
move the GoogleDocstring test to the appropriate test class
2020-08-04 11:36:15 +02:00
Keewis
278a057104
move the return types and yield types tests to above the raises test
2020-08-04 11:35:39 +02:00
Keewis
fa760c326a
move the translations to a named variable
2020-08-04 11:30:14 +02:00
Keewis
697fc8b16c
add test for the raises, yields and returns sections
2020-08-04 11:25:57 +02:00
Keewis
2e3e22ee03
apply the type preprocessor only after the check for prefer_type
2020-08-04 11:06:59 +02:00
Keewis
cac6d1787d
preprocess even with napoleon_use_param = False
2020-08-04 10:43:31 +02:00
Chris Mayo
9bac86a2fc
Fix typo sphinx-buid in internationalization figure
2020-08-03 19:30:38 +01:00
Chris Mayo
fe4a158caf
Fix typos in the documentation
2020-08-03 19:30:38 +01:00
Takeshi KOMIYA
a721631a54
Merge pull request #8043 from tk0miya/refactor_autodoc
...
refactor autodoc: Documenter.filter_members()
2020-08-03 22:34:11 +09:00
Takeshi KOMIYA
281647b657
Merge pull request #8044 from tk0miya/refactor_test_ext_autodoc
...
refactor: test: Rename target.enum to target.enums
2020-08-03 22:33:46 +09:00
Keewis
c4dc1b39d3
Merge branch '3.x' into custom-get_documenter
2020-08-02 22:21:19 +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
Keewis
2a3f6e4d70
don't try to split along ', '
2020-08-02 19:28:01 +02:00
Takeshi KOMIYA
59f68baddd
refactor: autodoc: Check special-member or not using regexp
2020-08-03 01:59:53 +09:00
Takeshi KOMIYA
46f0b3063d
refactor: autodoc: Add EMPTY that matches to no members
...
Add a special class `_Empty` to make the comparison of
:exclude-members: option simply. It never matches to any members.
2020-08-03 01:59:53 +09:00
Takeshi KOMIYA
a9e0c4b515
refactor: autodoc: ALL matches to any members
...
Add a special class `_All` to make the comparison of :*-members: option
simply. Now it matches to any members.
2020-08-03 01:58:35 +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
Keewis
95897349b9
fix the calls of the custom documenter functions
2020-08-02 15:53:47 +02:00
Keewis
95cb391bcf
actually use it as a method
2020-08-02 14:48:14 +02:00
Keewis
7bbcc3e07b
Merge branch '3.x' into custom-get_documenter
2020-08-02 14:46:35 +02:00
Keewis
83905c61b0
convert to a method
2020-08-02 14:41:13 +02:00
Keewis
2bdaa6c23e
implement the dispatching
2020-08-02 14:05:36 +02:00
Keewis
c212f5842c
allow registering custom get_documenter functions
2020-08-02 14:05:09 +02:00
