Commit Graph

920 Commits

Author SHA1 Message Date
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
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
Georg Brandl
ea8fad0de6 Removed the `sphinx.ext.refcounting` extension -- it is very specific to
CPython and has no place in the main distribution.
2013-10-12 19:27:49 +02:00
Eric Knibbe
0b22e43653 Added more domain links. 2013-10-08 14:35:32 +00:00
Takayuki Shimizukawa
e81a2d884e Added a ez_setup to replace distribute_setup. ez_setup become defacto. Closes #1264 2013-10-03 05:55:58 +00:00
Georg Brandl
8870db8787 grammar fix 2013-10-01 19:51:45 +02:00
Takayuki Shimizukawa
dab3f56267 Merged in erikb85/sphinx (pull request #154)
Removing "sphinx" prefix from Latex class parsing
2013-09-23 22:53:10 +09:00
Erik Bernoth
831f450bba Note in the documentation, that prepending "sphinx" is not necessary anymore. 2013-09-23 13:54:18 +02:00
anatoly techtonik
02123adce4 add link to IRC channel 2013-09-21 07:55:37 +00:00
Georg Brandl
d0cf2617cf Merged in dcmouser/sphinx-fork-dcmouser (pull request #161)
Added option to apidoc to write each module to standalone page instead of combining all modules in a package on one page.
2013-09-17 14:39:04 +02:00
Georg Brandl
7b8f78afac Small doc fixes for setuptools change. 2013-09-17 07:51:30 +02:00
Takayuki Shimizukawa
93e7623cd8 Add feature: theme package collection by using setuptools plugin mechanism. 2013-09-16 23:57:58 +09:00
Georg Brandl
44418fd1a1 changelog update for PR#136 2013-09-16 09:26:14 +02:00
Georg Brandl
d2b4f9a095 Merged in Vladimirsson/sphinx (pull request #136)
Added ``imported-members`` option for ``automodule`` directive in autodoc
2013-09-16 09:23:56 +02:00
Georg Brandl
de2e47bfce IRC channel update. 2013-09-16 09:16:08 +02:00
Georg Brandl
eafc199e06 Locale update: new locales, others updated from Transifex. 2013-09-16 09:02:06 +02:00
Georg Brandl
4b3a0b677d Add the cover of the Learning Sphinx book as an image. 2013-09-16 05:17:38 +02:00
Georg Brandl
900c50dd92 merge with stable 2013-09-16 05:10:27 +02:00
Georg Brandl
3541cef023 Update link to Japanese translation of the docs, and a link to the new OReilly book. 2013-09-16 05:09:05 +02:00
Georg Brandl
7c7c5af02a Merged in mcmtroffaes/sphinx-html-extra-path (pull request #158)
Add html_extra_path option to copy additional files ad verbatim to the output root folder.
2013-09-16 04:28:22 +02:00
Georg Brandl
e732807869 Merged in JonnyJD/sphinx/autodoc_novalue (pull request #109)
feature: autodoc: add :annotation: option for autodata and autoattribute
2013-09-16 04:25:53 +02:00
Georg Brandl
d521ebf93e Fixup docfield example usage. 2013-09-16 03:51:02 +02:00
dc mouser
3f888742ff Added option to apidoc to have it output each module to its own page and updated apidoc docs. 2013-09-08 16:25:41 -05: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
Matthias C. M. Troffaes
28873bfa6a Set up initial test. 2013-08-22 09:20:47 +01:00
Matthias C. M. Troffaes
57aceed4ed Add and document html_extra_path option. 2013-08-22 08:51:06 +01:00
Roland Meister
88c72be190 Add warning for unusual chars in filenames. Closes #1199 2013-08-10 15:36:05 +02:00
Takayuki Shimizukawa
d9f5439ffe fix: broken document format (rst) 2013-07-14 14:43:21 +09:00
Eric Holscher
f62a28d805 Add link to referenced docutils docs. 2013-07-11 13:30:17 -07:00
Roland Meister
73a1420cc6 Add epub_guide entry to doc/conf.py
The toc for the spinx documentation actually is in contents.rst.
2013-06-19 21:02:27 +02:00
Roland Meister
cc909ab2a9 More docs cleanup; add hint for the epub cover page 2013-06-07 20:48:14 +02:00
Roland Meister
2f5b7b8db1 Adjust docs about inline URLs for the epub builder 2013-06-06 21:53:59 +02:00
Roland Meister
ce6b8fff70 Clarify docs for the format and builder tags 2013-06-06 21:23:16 +02:00
Roland Meister
f879346cea Add the builder name as predefined tag for the only directive.
At the moment only the epub builder distinguishes between format and name.
Explicit entries with format_ and builder_ prefix are also added.
2013-04-25 23:08:30 +02:00
Bogdan Opanchuk
a7a4f7569a Added `imported-members option for automodule` directive in autodoc 2013-04-20 21:58:18 +10:00
Takayuki Shimizukawa
75a128b0f8 integrate 'translationguide.rst' into 'intl.rst' 2013-04-13 18:16:48 +09:00
Takayuki Shimizukawa
3b9ae95d01 update translation document 2013-04-11 23:45:15 +09:00
Roland Meister
36157e7cb8 Merged in rolmei/sphinx-epub (pull request #129)
footnote setting for epub_show urls
2013-04-08 23:14:05 +02:00
Georg Brandl
ff769018ca Add a section about updating locales to the devguide. 2013-04-05 16:42:47 +02:00