Takeshi KOMIYA
01a526793d
Fix typos #2122 (cherry-picked by hand)
2016-01-02 11:17:59 +09:00
shimizukawa
25251a3d53
Closes #1651 : Documentation: add `vartype` field description for python domain.
2015-03-09 22:51:20 +09:00
Jakob Lykke Andersen
b1775cbf8c
Add convenience directives and roles to C++ domain
...
Add directive `cpp:var` and roles `cpp:var` and `cpp:any`.
Fixes sphinx-doc/sphinx#1577 , fixes sphinx-doc/sphinx#1744 .
2015-02-26 21:44:46 +01:00
Jakob Lykke Andersen
44ee988981
C++, update docs and enums. Fixes sphinx-doc/sphinx#772 .
2015-02-08 23:09:44 +01:00
Jakob Lykke Andersen
d8a109976b
Merge from master
2015-02-07 00:55:19 +01:00
Jakob Lykke Andersen
c010b47589
C++, initial enum support (see #772 )
2015-01-03 16:59:08 +01:00
Georg Brandl
6c194ad56f
Closes #1623 : Return types specified with `:rtype:` are now turned into links if possible.
2014-11-12 11:32:21 +01:00
Takayuki Shimizukawa
da651089e7
fix trailing space and long line
2014-10-09 23:53:33 +09:00
Jakob Lykke Andersen
9230dd6a89
Doc, update C++ domain.
2014-08-06 18:54:00 +02:00
Jakob Lykke Andersen
c19a15ea0d
Doc, update C++ domain.
2014-07-27 11:42:01 +02:00
EricFromCanada
4883e1eba2
more corrections for spelling and grammar
2014-06-19 12:14:47 -04:00
EricFromCanada
178a97cd73
improved consistency for how docs refer to True and False
2014-06-18 12:34:28 -04:00
EricFromCanada
65e924a3e4
rewrapping paragraphs when over 80 characters wide
2014-06-18 11:53:25 -04:00
Georg Brandl
1eb23c62ce
merge with stable
2014-01-22 18:13:49 +01:00
Georg Brandl
2acaf03270
Closes #1357 : Option names documented by :rst:dir:option are now again allowed to
...
not start with a dash or slash, and referencing them will work correctly.
2014-01-22 17:42:38 +01:00
Georg Brandl
dbd544d12b
More tweaks to the py domain docs.
2014-01-13 20:13:44 +01:00
Georg Brandl
78b5d9aac2
Overhaul py directive documentation, remove old practices.
2014-01-13 19:12:42 +01:00
Georg Brandl
9708319f5c
docs: fix some broken links
2014-01-13 00:05:22 +01:00
Georg Brandl
6deebc4ef0
minor doc fixes
2014-01-11 14:52:41 +01:00
Georg Brandl
5dedeb30b0
py:decorator clarification
2013-11-25 20:43:23 +01:00
Georg Brandl
1efbc75905
Clarify use of signatures in python domain directives.
2013-11-24 16:02:34 +01:00
Eric Knibbe
0b22e43653
Added more domain links.
2013-10-08 14:35:32 +00:00
Georg Brandl
d521ebf93e
Fixup docfield example usage.
2013-09-16 03:51:02 +02:00
Kevin Burke
8faf315643
Add more inline examples
...
The idea is to show off all of the supported functionality of Sphinx
autodocs for domains in the given example. I always get confused about
the format for raised exceptions, etc. It would be great if this was a
little bit more of a comprehensive reference.
2013-09-05 09:52:54 -07:00
Robert Lehmann
31536aafa2
Link domains provided by sphinxcontrib.
2012-11-02 16:52:55 +01:00
Robert Lehmann
edebdbbb7b
Update domains provided by sphinxcontrib.
2012-11-02 16:02:32 +01:00
Jeffrey Finkelstein
01a350c198
Added other domains currently listed in the sphinx-contrib repository (including Ada, Erlang, HTTP, PHP, and Ruby).
2012-02-24 01:09:32 -05:00
Armin Ronacher
5315d23365
Attach arrays to the name not the type for C++ domain and fixed a few rendering errors.
2011-09-23 00:48:52 +02:00
Daniel Neuhäuser
e46a8e9ded
Change redirected URLs to the new locations
2011-02-05 21:48:54 +01:00
Georg Brandl
c6028c4405
#478 : Added :rst:dir:py:decorator directive to describe decorators.
2011-01-08 10:07:42 +01:00
Georg Brandl
8a3598ff8e
Cross-reference to role docs.
2011-01-06 20:44:55 +01:00
Georg Brandl
3e8834503f
#550 : fix confusing example in docs.
2010-11-12 08:26:20 +01:00
Georg Brandl
df107e70f8
Allow breaking long signatures, continuing with backlash-escaped newlines.
2010-08-05 16:03:36 +02:00
Georg Brandl
580e1c90d3
#481 , #482 : fix `.name` reference matching.
...
#482 : When doing a non-exact search, match only the given type of object.
#481 : Apply non-exact search for Python reference targets with ``.name`` for modules too.
2010-08-05 13:39:23 +02:00
Georg Brandl
c891fdfc60
Document new :py:func:.blah syntax.
2010-06-12 11:37:56 +02:00
Georg Brandl
3ff350c4d9
#439 : angle brackets in template class names can be misinterpreted as link targets. Clarify how to avoid this.
2010-06-05 18:21:48 +02:00
Armin Ronacher
475c3ba93b
Fixed a C++ bug that caused bad references to be generated. This also
...
adds a note on overloads always ending up on the first version of the
method in case more than one is defined.
2010-05-30 13:51:50 +02:00
Armin Ronacher
6613b64726
Added class role docs for JS domain.
2010-05-27 16:18:38 +02:00
Armin Ronacher
a534f39187
Fixed a bug in the C++ domain and documented more
2010-05-27 14:12:24 +02:00
Armin Ronacher
8c388b8b14
Added :js:class: which makes JS documentation a lot more readible
2010-05-27 13:52:02 +02:00
Armin Ronacher
31aed65b6f
Usefulified C++ code example
2010-05-27 13:41:16 +02:00
Georg Brandl
6dedbfff21
Mention domains in sphinx-contrib.
2010-05-24 22:59:02 +02:00
Georg Brandl
4d0facf1e1
Add the "oldcmarkup" extension, to help migrating to 1.0.
2010-05-24 15:12:27 +02:00
Georg Brandl
0f2a0381ba
Rename default_domain to primary_domain; give it special semantics.
2010-05-23 16:48:54 +02:00
Georg Brandl
f4f3066581
Use the new rst domain in the sphinx docs.
2010-04-17 10:39:51 +02:00
Georg Brandl
541e30b36e
Cleanup trailing whitespace and fix a few nits with the rst domain.
2010-04-17 10:29:14 +02:00
Leontius Adhika Pradhana
a097525e15
Added documentation... and removed another stray debug line.
2010-04-16 03:55:18 +08:00
Georg Brandl
b2a7db4a81
Review of JS domain. Adapt coding style a bit.
2010-04-08 21:33:03 +02:00
Daniel Neuhäuser
ae0d464fb1
Added doc_field_types to :class:JSCallable, arguments, errors and the return value of JavaScript functions/methods/constructors can now be documented using fields.
2010-03-31 15:15:43 +00:00
Daniel Neuhäuser
5831add5bb
Added a :js:attribute:: directive as well as a :js:attr: role to describe attributes of javascript objects.
2010-03-30 22:22:57 +00:00
