Takeshi KOMIYA
be36cf471b
Merge pull request #9679 from latosha-maltba/doc/directive-indent
...
Document indent behaviour for directives
2021-10-09 16:26:52 +09:00
Takeshi KOMIYA
481c5e9c4b
Merge pull request #9534 from astrojuanlu/new-tutorial-describing-code
...
New Sphinx tutorial, part III
2021-10-09 13:05:48 +09:00
Jakob Lykke Andersen
a6246c1b65
Typo fixes
2021-10-01 20:48:12 +02:00
Jakob Lykke Andersen
91d0289009
C++, add retval info field to cpp:function
2021-10-01 20:47:14 +02:00
Jakob Lykke Andersen
57fad5c044
C, update documentation for info-fields
2021-10-01 18:38:30 +02:00
Latosha Maltba
ee3f361992
Document indent behaviour for directives
...
Mention how the indent of the contents for directives is chosen and what
the effect on directives which are sensitive to whitespace is,
e.g. code-block.
2021-09-27 09:06:52 +00:00
Juan Luis Cano Rodríguez
2c1fa831c1
Add tutorial section on documenting Python objects
2021-08-12 20:06:56 +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
Takeshi KOMIYA
5ce5f40402
Merge pull request #9340 from ocket8888/patch-1
...
Update example to use recommended usage
2021-07-07 01:50:34 +09:00
Juan Luis Cano Rodríguez
50bd1c3967
Remove unnecessary label
2021-07-05 09:22:14 +02:00
Juan Luis Cano Rodríguez
3fcaa172db
Move reference to list of Pygments lexers
2021-06-21 07:38:51 +02:00
Juan Luis Cano Rodríguez
57b0a1b465
Add section about the toctree
2021-06-17 00:31:53 +02:00
ocket8888
9db8775ba7
Update example to use recommended usage
2021-06-14 11:21:28 -06:00
igo95862
6c5f77c689
doc: Upgrade pygments.org links to HTTPS
2021-05-16 15:53:58 +03:00
igo95862
e67c9e5df1
doc: Upgrade docutils.sourceforge.io links to HTTPS
...
Also change any docutils.sourceforge.net link to io
top level domain.
2021-05-16 15:53:49 +03: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
Takeshi KOMIYA
3059a999b2
Close #8326 : Rename master_doc to root_doc
...
To describe the purpose more accurately, the `master_doc` is now renamed
to `root_doc`. The old name is still available. But it is recommeneded
to use new one from now on.
2021-02-28 17:10:57 +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
Harrissou Sant-anna
08c2c23bb4
Make code block types more visible
2021-02-08 13:03:16 +01:00
Takeshi KOMIYA
502c4ee5fb
Merge branch '3.x'
2021-01-24 14:32:13 +09:00
Takeshi KOMIYA
3100ceb220
doc: minor fix
2021-01-23 22:32:17 +09:00
Takeshi KOMIYA
f707cb30a1
Merge pull request #7798 from stefanodavid/code-block-crossref-doc
...
documentation for proper code-block cross-referencing
2021-01-23 22:31:02 +09:00
Guillaume Melquiond
8a1d0d0da6
Allow production lists to refer to tokens from other production groups.
...
Outside production lists, syntax "`foo:bar`" already makes it possible to
refer to the production "bar" of group "foo". This commit offers the same
feature inside production lists. Similarly to the reference syntax,
prefixing with a tilde prevents the group from being displayed.
This commit also makes it possible to use "`:bar`" to refer to production
"bar" from a production list without a group name. This is especially
useful when one has a main (unnamed) grammar and one or several named
extensions that need to refer to it.
2021-01-20 17:57:52 +01:00
Takeshi KOMIYA
30f8640bab
Merge branch '3.x'
2021-01-16 21:51:46 +09:00
Takeshi KOMIYA
fddc42847f
Fix #2030 : automatic dedent support in code-block directive
2021-01-13 01:10:28 +09:00
Takeshi KOMIYA
598b85da75
Merge branch '3.x' into master
2020-10-04 22:41:44 +09:00
François Freitag
5166dd194c
Strip trailing whitespaces and normalize line endings
...
Trailing whitespace do not have impact on the result, they are just
unused bytes. Most text editors are configured to strip trailing
whitespaces. Remove them all in one go.
Update a handful of files to use the UNIX line ending.
2020-10-03 13:47:01 +02: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
a8927bcd3e
Merge branch '3.x'
2020-08-08 18:16:59 +09:00
Chris Mayo
fe4a158caf
Fix typos in the documentation
2020-08-03 19:30:38 +01:00
Takeshi KOMIYA
c14c00397e
Merge branch '3.x'
2020-08-01 16:59:00 +09:00
Ebram Shehata
df2d4839c4
Update basics.rst
2020-07-29 15:14:29 +02:00
Chris Holdgraf
84f7dffd99
comments
2020-07-29 10:38:18 +01:00
Chris Holdgraf
60b105d6aa
several documentation improvements to theming, templating, and extension development
2020-07-29 10:38:18 +01:00
Yoshiki Shibukawa
70aa913bb2
fix 6863: add description literalinclude option (start/end have same string)
2020-07-25 22:36:06 +09: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
