Commit Graph

957 Commits

Author SHA1 Message Date
Georg Brandl
c24cfbaed1 Add an example how to connect events. 2014-03-26 07:30:48 +01:00
Georg Brandl
b944c843f5 Add warnings that autodoc imports the modules. 2014-03-05 07:45:45 +01:00
Georg Brandl
501c2d13e6 Fix long lines. 2014-03-02 08:40:48 +01:00
Georg Brandl
e030031321 Update copyright year. 2014-03-01 08:18:16 +01:00
Robert Lehmann
529519275e Fixed W3C Validator errors in index page. 2014-02-05 15:06:59 +01:00
Georg Brandl
2a2b59598c link to extdev doc from develop 2014-02-02 08:03:48 +01:00
Georg Brandl
cf60ef0e75 Update list of extensions in sphinx-contrib. 2014-01-26 11:40:22 +01:00
Georg Brandl
25ac2dda9c add link 2014-01-24 20:22:58 +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
38f47bc0ef Closes #1356: link to page with valid Pygments lexer alias 2014-01-22 17:28:04 +01:00
Georg Brandl
fb5a1a09a0 some directive creation docs 2014-01-21 10:32:30 +01:00
Georg Brandl
6b33e3fea4 remove duplicate wording 2014-01-21 10:05:23 +01:00
Georg Brandl
cc8d29dcab actually use exception markup 2014-01-21 10:04:11 +01:00
Georg Brandl
da09100869 doc: add exceptions from sphinx.errors 2014-01-21 09:54:31 +01:00
Georg Brandl
fe5ac65311 Merged in ViktorHaag/sphinx/stable (pull request #211)
Fix for issue #1352
2014-01-20 21:16:33 +01:00
Viktor Haag
3c0c9cd198 updates per Georg Brandl:
- Change alteration to docs to express path relative to "configuration directory" and not "conf.py"
- Update block in HTML builder copying favicon to _static to mirror handling of html_logo
2014-01-20 13:27:52 -05:00
Georg Brandl
883324fd6c Doc: move API docs in their own chapter and add more of it. 2014-01-20 17:21:44 +01:00
Viktor Haag
549b176c85 merge to tip 2014-01-20 10:37:51 -05:00
Viktor Haag
3706ed02ac address issue #1352 -- make sure to check for the actual file stored in config.html_logo. 2014-01-20 10:37:37 -05:00
Georg Brandl
aecf35c1bd mention loglevel 2014-01-20 11:21:30 +01:00
Georg Brandl
0e182d1d2b devguide: small updates 2014-01-20 08:51:47 +01:00
Georg Brandl
ce49286240 Closes #1071: add mention of "orphan" to toctree docs 2014-01-19 18:12:52 +01:00
Georg Brandl
48aeed6fd8 add back missing @ 2014-01-19 17:49:57 +01:00
Georg Brandl
1653c5d242 Make mode: refactor using a class and add source dir to the makefile 2014-01-19 16:23:23 +01:00
Georg Brandl
411d88a90e Merged in birkenfeld/sphinx-new-make-mode/stable (pull request #203)
Add "make mode" to sphinx-build, invoked by the -M flag.
2014-01-19 15:38:23 +01:00
Georg Brandl
91d92be8ad Add "make mode" to sphinx-build, invoked by the -M flag.
This is intended to do almost all of what the quickstart-generated Makefile
and make.bat did, but within Sphinx.  The advantages are:

* no duplication between Unix and Windows files
* updates and fixes are propagated (the generated makefiles never update)
* more Python code, less shell code!
2014-01-11 19:36:05 +01:00
Georg Brandl
6deebc4ef0 minor doc fixes 2014-01-11 14:52:41 +01:00
Georg Brandl
b29226a060 Closes #845: In code blocks, when the selected lexer fails, display line numbers nevertheless if configured. 2014-01-11 10:00:49 +01:00
Georg Brandl
166ac0d5ca fix target confusion 2014-01-10 21:44:59 +01:00
Georg Brandl
8b2417bc6d small fixes in intl document 2014-01-10 21:25:59 +01:00
Georg Brandl
2b6dc512b8 doc intro: add a pointer to readthedocs.org 2014-01-10 15:22:39 +01:00
Georg Brandl
bae7682bad merge with intersphinx tutorial section 2014-01-10 14:55:25 +01:00
Takayuki Shimizukawa
bcff26c6da update a Intersphinx tutorial section. refs #1325 2013-12-18 08:33:37 +09:00
Eric Knibbe
6c70ea2aae corrected descriptions of tabularcolumns specifiers 2013-12-17 18:14:28 +00:00
Eric Knibbe
9298e15ae0 recommend exclude_patterns instead of unused_docs or exclude_trees 2013-12-17 18:12:54 +00:00
Takayuki Shimizukawa
1367f6f9c6 Added a "Intersphinx" tutorial section. (:file:doc/tutorial.rst). Closes #1325 2013-12-17 23:54:30 +09: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
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
a72406d434 Closes #1328: clarify that builder-specific tags are not available when conf.py is executed. 2014-01-12 22:40:50 +01:00
Georg Brandl
123572e1db #1345: Fix two bugs with :confval:nitpick_ignore; now you don't have to
remove the store environment for changes to have effect.
2014-01-12 20:45:34 +01:00
Georg Brandl
3f1235e2ea doc: note that "image" paths should not have spaces. 2014-01-12 16:28:27 +01:00
Georg Brandl
31aed07386 Closes #1156: bring manpage up to scratch with current options and builders. 2014-01-12 16:07:21 +01:00
Georg Brandl
9d25862700 add link to "write the docs", move hosting chapter to home page 2014-01-12 12:44:36 +01:00
Georg Brandl
d38c5cac8d Closes #1082: clarify that html_title default value does not really have placeholders 2014-01-11 21:03:56 +01:00
Georg Brandl
48524dcecc Closes #983: clarify "docstitle" behavior with singlehtml 2014-01-11 20:18:37 +01:00
Georg Brandl
453290fc66 doc: make it more prominent that sub-toctrees shouldnt get :numbered:
Should be enforced programmatically at some point!
2014-01-11 19:54:47 +01:00
Georg Brandl
c5ff9386d6 Fix autodoc. 2013-10-12 21:01:25 +02:00
Georg Brandl
695cebd254 Add sphinx.version_info for better programmatic check of the Sphinx version. 2013-10-12 20:48:03 +02:00