Jakob Lykke Andersen
57fad5c044
C, update documentation for info-fields
2021-10-01 18:38:30 +02:00
Takeshi KOMIYA
120525563c
Cloase #9445 : :py:property: directive now supports :classmethod: option
...
Since python 3.9, `classmethod` starts to support creating a "class
property". This allows to describe it.
2021-07-17 14:24:31 +09:00
Eisuke Kawashima
652ebf1bf5
Fix typo
2021-07-08 08:16:22 +09:00
ocket8888
9db8775ba7
Update example to use recommended usage
2021-06-14 11:21:28 -06:00
Takeshi KOMIYA
d8fa067583
Add doc and testcase for program directive (refs: #9137 )
...
There is no docs and testcases for "None" argument of the program
directive. It has been implemented since very old version. But it's
not documented and tested long.
2021-04-28 02:16:57 +09:00
Takeshi KOMIYA
41a377fee5
Merge branch '3.x'
2021-04-04 00:06:45 +09:00
Albert Villanova del Moral
260725c823
Fix minor typo
2021-03-30 08:45:34 +02:00
Takeshi KOMIYA
204f86f736
py domain: Add py:property directive to describe a property (refs: #7068 )
2021-03-11 01:56:39 +09:00
jfbu
62401ef1ec
Merge branch '3.x'
2021-02-12 21:27:17 +01:00
Jakob Lykke Andersen
a7fcc15683
C++, add noroot option to alias directive
2021-02-12 17:25:12 +01:00
Jakob Lykke Andersen
06a956200b
C, add noroot option to alias directive
2021-02-12 17:25:12 +01:00
Jakob Lykke Andersen
d0a4d0147e
C++, add recursiveness to alias
...
Fixes sphinx-doc/sphinx#8213 in the most basic way.
2021-02-12 17:25:12 +01:00
Takeshi KOMIYA
26ea870267
Merge branch '3.x' into master
2020-10-03 13:43:21 +09:00
Steve Piercy
81d7f2ee8a
Update link to sphinxcontrib on GitHub
2020-09-26 16:32:59 -07:00
Jakob Lykke Andersen
500f45fd4c
C, recursive alias declarations
...
Fixes sphinx-doc/sphinx#8141
2020-09-13 16:37:53 +02:00
Takeshi KOMIYA
1a223209f2
Merge branch '3.x'
2020-07-05 19:56:21 +09:00
Jakob Lykke Andersen
c668500a4b
Add :noindexentry: option
...
Fixes sphinx-doc/sphinx#7052
2020-07-04 19:34:00 +02:00
Takeshi KOMIYA
ec3754bd94
Merge branch '3.x'
2020-07-05 01:32:54 +09:00
Jakob Lykke Andersen
8c82ecbf2c
Merge pull request #7895 from jakobandersen/c_cpp_noindex
...
C, C++: remove noindex option
2020-07-02 15:38:45 +02:00
Jakob Lykke Andersen
ff5eb7cc2b
C, C++: remove noindex option
...
The option did nothing.
Improve error messages on duplicates.
2020-06-30 13:52:18 +02:00
Jakob Lykke Andersen
7cbf54c210
C, add c:alias directive
2020-06-30 11:20:17 +02:00
Takeshi KOMIYA
e5dad73cf2
py domain: Add :canonical: option
2020-05-04 14:49:50 +09:00
Takeshi KOMIYA
87308d9607
Close #7143 : py domain: Add :final: option to py:*: directives
2020-04-28 01:24:29 +09:00
Takeshi KOMIYA
b2a601a33d
Merge branch '3.0.x' into 3.x
2020-04-13 23:36:10 +09:00
Jakob Lykke Andersen
d4058eb67f
C, parse attributes
2020-04-13 13:43:26 +02:00
Jakob Lykke Andersen
bbc7b6cc54
C, add scoping directives
2020-04-12 14:13:54 +02: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
2e87ee85a2
Merge branch '2.0'
2020-02-09 00:57:53 +09:00
Takeshi KOMIYA
179a1f9cc2
py domain: Support type annotations for variables
...
This adds ``:type:`` and ``:value:`` options to both ``py:data``
and ``py:attribute`` directives. It allows to describe its
annotation in detail.
2020-02-01 12:58:27 +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
jfbu
dc53404d48
Fix markup issue in our docs
2019-11-26 14:22:17 +01:00
Takeshi KOMIYA
d6063ff35b
doc: Fold lines by 80 columns
2019-05-30 01:07:05 +09:00
Takeshi KOMIYA
9b2423c5bb
doclinter: restrict by 90 columns
2019-05-26 10:53:53 +09:00
Takeshi KOMIYA
3105feec80
doc: Update with rst:directive:option directive
2019-05-20 00:26:28 +09:00
Takeshi KOMIYA
358e582490
Add :abstractmethod: option to py:method directive (refs: #6138 )
2019-05-15 00:00:51 +09:00
Takeshi KOMIYA
416426dfb7
Merge pull request #6356 from tk0miya/foldlines
...
Add utils/doclinter.py; a documenter linter for Sphinx
2019-05-13 14:39:01 +09:00
Takeshi KOMIYA
ca605c7437
Add :type: option for rst:directive:option directive
2019-05-13 14:14:14 +09:00
Takeshi KOMIYA
4307dec3ac
Add rst:directive:option directive
2019-05-13 13:55:56 +09:00
Takeshi KOMIYA
fa00458f4f
docs: Fold lines by 80 chars
2019-05-12 17:57:38 +09:00
Takeshi KOMIYA
a142a654fc
Add :property: option to py:method directive
2019-05-12 15:53:39 +09:00
Takeshi KOMIYA
e0abb10792
Fix #4777 : Add :async: option to py:function and py:method directives
2019-04-23 01:40:37 +09:00
Takeshi KOMIYA
331594e2ca
Add :classmethod: and :staticmethod: options to py:method directive
2019-04-13 23:14:59 +09:00
Antony Lee
386ec9cd9a
Fix doc typo.
2019-03-07 14:17:41 +01:00
Takeshi KOMIYA
ba86f4ea78
Merge branch '2.0'
2019-03-07 01:23:26 +09:00
Takeshi KOMIYA
10869289ef
docs: JS domain does not support reset current module
2019-03-03 14:56:38 +09:00
Stephen Finucane
b1ebdcd3c6
doc: Add "recipe" tutorial
...
This is based on a post from opensource.com [1] and demonstrates how one
can use indexes for cross-referencing and domains to group these indexes
along with domains and roles. The source code was taken from [2] after
getting the license changed [3].
[1] https://opensource.com/article/18/11/building-custom-workflows-sphinx
[2] https://github.com/ofosos/sphinxrecipes
[3] https://github.com/ofosos/sphinxrecipes/issues/1
Signed-off-by: Stephen Finucane <stephen@that.guru>
2019-02-09 17:58:30 +00:00
Frank Erens
9e6fe21c6a
Add 'cpp:struct' directive and 'cpp:struct' role.
...
They are cosmetic variants of the class directive/role.
2019-01-20 12:29:20 +01:00
Jakob Lykke Andersen
4e6dacd81b
C++, add some missing .. versionadded directives.
2019-01-20 12:28:57 +01:00
