Commit Graph

659 Commits

Author SHA1 Message Date
Georg Brandl
3c9619ac4b Add explicit hint about compiling message catalogs. 2010-04-06 19:31:35 +02:00
Daniel Neuhäuser
92027ce19f Merge with sphinx-domains. 2010-04-06 13:16:27 +00:00
Georg Brandl
751e02c767 merge with trunk 2010-04-06 09:23:03 +02:00
Georg Brandl
517b045f86 merge with 0.6 2010-04-06 09:21:22 +02:00
Georg Brandl
454c9d3b9e #354: add link to rst2pdf manual. 2010-04-04 20:04:44 +02:00
Georg Brandl
aa08703a07 Fix file name where example docs are located. 2010-04-04 19:04:01 +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
Daniel Neuhäuser
8cbdf1ec34 It is now possible to use the js:function:: directive for methods. 2010-03-30 21:50:48 +00:00
Daniel Neuhäuser
9d53f460ea Added a js:data directive/role to describe/refer to global variables/constants. 2010-03-30 19:39:18 +00:00
Daniel Neuhäuser
25b8e87fee Added a :js:func: role to refer to functions described with the js:function:: directive. 2010-03-30 19:14:01 +00:00
Daniel Neuhäuser
9837a08294 Added a JavaScript domain and a js:function directive. 2010-03-30 18:40:46 +00:00
Georg Brandl
a5a08531ee merge with 0.6 2010-03-16 08:53:12 +01:00
Georg Brandl
1ea64352fe A bit more tutorial. 2010-03-14 19:46:54 +01:00
Georg Brandl
79f30848c2 Add link to inline markup spec. 2010-03-14 14:31:45 +01:00
Georg Brandl
1998065b4f Add minimal documentation for the C++ domain. 2010-03-09 19:38:49 +01:00
Georg Brandl
c219938a73 Write a bit more of the tutorial. 2010-03-09 19:32:59 +01:00
Georg Brandl
79e824d96a Add shortcut for SPHINXOPTS. 2010-03-01 22:31:17 +01:00
Georg Brandl
4f2523d17f Mention standard rst roles in inline markup. 2010-03-01 15:01:46 +01:00
Georg Brandl
a479d56b24 Move inline markup description to domains page. 2010-03-01 14:53:30 +01:00
Georg Brandl
3e9182550a Review markup chapter. 2010-03-01 14:37:31 +01:00
Georg Brandl
a83f9e7686 Make it clear that the default for "collapse" is True. 2010-02-28 19:54:25 +01:00
Georg Brandl
9334d1537c Add some domain documentation. 2010-03-01 14:22:14 +01:00
Georg Brandl
0ee675b7cf Update blurb in setup.py and on the index page, link directly to tutorial.rst from index. 2010-02-28 23:12:00 +01:00
Georg Brandl
700c831ae7 Add a bit more info. 2010-02-28 23:03:38 +01:00
Georg Brandl
2cbe10086f Rename tutorial, add example for image substitution. 2010-02-28 23:03:16 +01:00
Georg Brandl
f36592e418 Begin the Great Refactoring of the docs.
* Move sphinx-build option description from intro to a new document.
* Move toctree information to a new document in markup/.
* Add a tutorial document placed after intro. Begin filling it in.
2010-02-28 22:00:22 +01:00
Georg Brandl
7f1eafb9a3 Re-export docutils .. class:: as .. rst-class:: and un-document .. cssclass::. 2010-02-28 19:30:30 +01:00
Georg Brandl
dc84392d22 List all docutils directives with short descriptions and links to the reference. 2010-02-28 17:42:41 +01:00
Georg Brandl
0feb7dacf2 Add a bit more content to the reST primer, and add links to the reST reference docs for all constructs. 2010-02-28 17:24:55 +01:00
Georg Brandl
04f660d021 Change domain-index API: introduce a class. 2010-02-28 14:45:43 +01:00
Georg Brandl
3d01c2c95f #282: Added a "nitpicky" mode that emits warnings for all missing references.
It is activated by the ``-n`` command-line switch or the ``nitpicky`` config value.
2010-02-28 12:13:55 +01:00
Georg Brandl
a31e7e2f5d #187: Added support for source ordering of members in autodoc, with `autodoc_member_order = 'bysource'`. 2010-02-28 11:39:13 +01:00
Georg Brandl
9a316a21a0 merge with trunk 2010-02-28 10:21:00 +01:00
Georg Brandl
adca1e02b0 Apply some changes to agogo, contributed by Florian Diesch. 2010-02-28 09:36:27 +01:00
Georg Brandl
5d56b325c1 merge 2010-02-27 23:27:16 +01:00
Georg Brandl
036a399011 merge with trunk 2010-02-27 23:14:19 +01:00
Georg Brandl
76eb148770 Add app.override_domain(). 2010-02-27 23:13:51 +01:00
Georg Brandl
832e290acd Add "orphan" metadata entry to suppress non-toctree-inclusion warnings. 2010-02-25 22:49:54 +01:00
Georg Brandl
07a658e50c Remove hand-written manpages, add rst documents to be built with the manpage builder. 2010-02-25 22:22:01 +01:00
Georg Brandl
5c92da1c12 Allow giving no authors. 2010-02-25 22:21:41 +01:00
Georg Brandl
51e8de3446 Update phony target lists. 2010-02-25 22:03:27 +01:00
Georg Brandl
fab92b215a Added `autodoc_default_flags` config value, which can be used
to select default flags for all autodoc directives.
2010-02-21 22:16:06 +01:00
Georg Brandl
750c3622fd Add some versionadded tags. 2010-02-21 21:57:58 +01:00
Georg Brandl
94e47ff6d8 merge with trunk 2010-02-21 21:49:54 +01:00
Georg Brandl
700dda624e merge with 0.6 2010-02-21 21:48:09 +01:00
Georg Brandl
b81b7a0463 Remove docs for autosummary features that are not actually in 0.6. 2010-02-21 21:46:07 +01:00
Georg Brandl
121b864f31 Add manual page writer. 2010-02-21 11:50:08 +01:00
Georg Brandl
d305ab2bd0 Add link to Qt help. 2010-02-20 19:57:13 +01:00
Georg Brandl
454ecf80a4 Make the concept of "module index" generalized to domains. As a side-effect, the latex modindex is no longer generated by LaTeX. 2010-02-20 01:13:23 +01:00