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
15,795 Commits 2 Branches 219 Tags 163 MiB
777bcb43fa
Commit Graph

15795 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
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
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
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
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
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
Takeshi KOMIYA
5be006124e
Merge pull request #8033 from tk0miya/8032_typehint_for_ivar_on_parentclass 
Fix #8032: autodoc: A typehint for inherited ivars is not shown
 2020-08-02 19:24:25 +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
cc25bac264
Merge pull request #8031 from tk0miya/8030_annotated_ivar_isnt_shown_with_inherited_members 
Fix #8030: autodoc: An annotated instance variable is not documented
 2020-08-02 18:25:22 +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
0cfb433b25
Merge pull request #8026 from tk0miya/7768_docpath_for_figure_language_filename 
Close #7768: i18n: figure_language_filename supports {docpath} token
 2020-08-02 16:43:54 +09: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
4f56fad7b7
Merge pull request #7986 from mgeier/css-highlight-selector 
basic CSS: fix "highlight-" selector
 2020-08-02 12:03:54 +09:00
Matthias Geier
416438366d Update CHANGES for PR #7986 2020-08-01 20:17:42 +02:00
Matthias Geier
c5180a6d3f basic CSS: fix "highlight-" selector 2020-08-01 20:15:32 +02: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
Takeshi KOMIYA
6225ffd238 Fix #8030: autodoc: An annotated instance variable is not documented 
Documenter.filter_members() have wrongly considered that an instance
variable not having a docstring should be skipped when
`:inherited-members:` option given.

This fixes the behavior when the instance variable has annotated.

Note: This doest not still detect well for not annotated instance
variables.
 2020-08-01 22:05:12 +09:00