IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
4,524 Commits 2 Branches 219 Tags 163 MiB
c24cfbaed1
Commit Graph

957 Commits

Author SHA1 Message Date
Georg Brandl
3020799a1e Add explicit hl language. 2011-01-06 19:42:37 +01:00
Georg Brandl
92a5db16d5 #516: Added new value of the :confval:latex_show_urls option to show the URLs in footnotes. 2011-01-06 18:29:37 +01:00
Georg Brandl
549c800f0b Remove control character. 2011-01-06 18:21:24 +01:00
Georg Brandl
772c94ef69 Remove latex-unsupported footnote in caption. 2011-01-06 18:20:57 +01:00
Georg Brandl
1675a454ce Added the :mod:sphinx.ext.mathjax extension, based on 
https://bitbucket.org/kevindunn/sphinx-extension-mathjax/ by Kevin Dunn.
 2011-01-06 13:21:36 +01:00
Georg Brandl
208e8a66e2 Add an option for the coverage builder if source-undocumented items are matched. 2011-01-04 22:50:13 +01:00
Georg Brandl
dd6984b7a9 merge with bb://mbrochh/sphinx 2011-01-04 22:22:23 +01:00
Georg Brandl
560e803cc1 merge with bb+http://jonathanj/sphinx 2011-01-04 22:11:57 +01:00
Georg Brandl
4ce378be29 #209: Added :confval:text_newlines and :confval:text_sectionchars config values. 2011-01-04 21:41:05 +01:00
Georg Brandl
442229dd97 Add `pyramid` theme. 2011-01-04 17:49:59 +01:00
Georg Brandl
7beb8533b5 #273: Add an API for adding full-text search support for languages other than English. Add support for Japanese. 
Based on the implementation by SHIBUKAWA Yoshiki in https://bitbucket.org/shibu/sphinx/.
 2011-01-04 12:40:19 +01:00
Georg Brandl
c5b5c16cb3 Fix some broken URLs. 2011-01-04 11:37:56 +01:00
Georg Brandl
17efae5622 merge with 1.0 2011-01-04 11:29:09 +01:00
Georg Brandl
51852c0e87 #472: linkcheck builder: Check links in parallel, use HTTP HEAD requests and allow configuring the timeout. 
New config values: :confval:`linkcheck_timeout` and :confval:`linkcheck_workers`.
 2011-01-04 11:27:42 +01:00
Georg Brandl
3642b521ed merge with 1.0 2011-01-04 00:35:27 +01:00
Georg Brandl
a304c8d247 Fix-up half-sentence. 2011-01-03 23:50:30 +01:00
Georg Brandl
f6cb763ff8 #564: Add :confval:autodoc_docstring_signature which retrieves the signature from the first line of the docstring, if it is found there. 2011-01-03 22:51:33 +01:00
Georg Brandl
594c1a90f4 #520: Provide `special-members` option for autodoc directives. 2011-01-03 21:56:41 +01:00
Georg Brandl
92cb77a131 #176: Provide `private-members` option for autodoc directives. 2011-01-03 21:48:37 +01:00
Georg Brandl
7401622583 #553: Added :rst:dir:testcleanup blocks in the doctest extension. 2011-01-03 21:20:29 +01:00
Georg Brandl
29d6167125 Remove html_permalink_text again and give meaning to html_add_permalinks. 2010-12-11 09:25:59 +01:00
Robert Lehmann
4a2ce98cd8 Recommend best practice instead of sphinx-to-github. 
Reported by the original author, Michael Jones, on sphinx-dev.
http://groups.google.com/group/sphinx-dev/msg/1faa6adbe1bf0819
 2010-12-09 10:44:31 +01:00
Daniel Neuhäuser
dd955b1f94 #559 Add html_permalink_text confval 2010-12-01 22:54:54 +01:00
Georg Brandl
80c3fc6000 Fix typo. 2010-11-24 17:12:05 +01:00
Georg Brandl
8e07433256 Remove more mentions of reject_comment. 2010-11-21 20:49:51 +01:00
Georg Brandl
a1f633ee03 merge 2010-11-12 08:29:27 +01:00
Georg Brandl
5ca3c9817a merge with 1.0. 2010-11-12 08:29:02 +01:00
Daniel Neuhäuser
7f254f1a77 Fixed a typo. Thanks to Thomas Waldmann for finding it. 2010-10-31 13:04:13 +01:00
Jonathan Jacobs
5ad1c7d03e Update config.rst with man_show_urls option, it still needs a version directive. 2010-10-24 23:40:16 +02:00
Georg Brandl
4cb330f8a6 #526: Add Iranian translation, thanks to Omid Raha. 2010-10-22 13:24:17 +02:00
Georg Brandl
b72621c447 #521: Added :confval:linkcheck_ignore config value. 2010-10-22 11:40:38 +02:00
Georg Brandl
db8189083d merge with 1.0 2010-10-22 11:16:48 +02:00
Georg Brandl
92f6212c98 Add add_node() support for texinfo and add handlers for nodes in our extensions. 2010-10-22 11:16:23 +02:00
Georg Brandl
bd268c7182 Few cleanups after texinfo builder merge (#529). Add CHANGES and AUTHORS entries. To do: add node handlers for all extension nodes so that the test documents can be handled without warnings. 2010-10-22 10:17:35 +02:00
Georg Brandl
e6f5d36a0b merge with http://bitbucket.org/jonwaltman/sphinx-info 2010-10-22 10:06:24 +02:00
Georg Brandl
e7ae435ea2 merge with 1.0 2010-10-10 21:48:15 +02:00
Daniel Neuhäuser
a3a0a96c3a Mention Sphinx Contrib in the documentation. 
Along with that I also removed the part about finding a place
to host extensions when a message about one is send to the
mailinglist, as I believe we have one for every extension
with Sphinx Contrib.
 2010-10-10 20:00:12 +02:00
Chris Rebert
ef62d317e5 autodoc's docstring/special-comment detection works for instance attributes too 2010-10-02 00:05:59 -07:00
Jonathan Waltman
464fee8523 Remove unused imports and clean up 2010-09-20 04:04:24 -05:00
Doug Hellmann
4a00029a43 add 'inline' flag to graphviz extension directives to control paragraph breaks 2010-09-16 09:29:04 -04:00
Jonathan Waltman
a5343b4c5b Add documentation for Texinfo builder 2010-09-16 02:16:27 -05:00
Georg Brandl
242555d6ca merge with 1.0 2010-09-10 09:09:55 +02:00
Daniel Neuhäuser
fee6b38142 Remove trailing whitespace 2010-09-03 17:10:22 +02:00
Robert Lehmann
6812af60c2 merge 2010-08-27 01:03:57 +02:00
Robert Lehmann
ef870346de Document internationalization mechanisms. 2010-08-27 01:02:49 +02:00
Georg Brandl
e5be4a841c merge with http://bitbucket.org/rolmei/sphinx-epub/ 2010-08-26 16:23:18 +00:00
Georg Brandl
ad759f54c1 #392: deprecate "centered". 2010-08-26 12:01:12 +00:00
Georg Brandl
3ddd7d9075 merge with 1.0 2010-08-25 12:02:59 +00:00
Georg Brandl
40e692e6c3 #504: Add an `index` role, to make inline index entries. 2010-08-25 11:33:30 +00:00
Georg Brandl
8ac32d08ba #221: Add Swedish locale, thanks to Henrik Holmboe. 2010-08-25 10:09:24 +00:00
Georg Brandl
2e520e5e7b #460: Allow limiting the depth of section numbers for HTML. 2010-08-25 09:59:53 +00:00
Georg Brandl
1961292029 merge with 1.0 2010-08-23 16:27:25 +00:00
Georg Brandl
9c2747da91 #443: Allow referencing external graphviz files. 2010-08-23 13:07:28 +00:00
Georg Brandl
aa9fabc1e1 merge with 1.0 2010-08-21 20:30:53 +02:00
Georg Brandl
2e17fac622 merge with DasIch/sphinx-i18n 2010-08-21 19:34:05 +02:00
Georg Brandl
7174c537c8 Update versionadded for SoC projects. 2010-08-21 19:23:05 +02:00
Georg Brandl
00c2b032d1 merge with sphinx-i18n 2010-08-21 19:20:50 +02:00
Georg Brandl
3048c13c63 Adapt style for websupport docs. 2010-08-21 19:15:14 +02:00
Robert Lehmann
7a40e07eda merge with trunk 2010-08-17 11:08:23 +02:00
Jacob Mason
c028b95cd0 merge with version tracking 2010-08-15 14:12:54 -05:00
Daniel Neuhäuser
30fe0ce9fb Automated merge with ssh://bitbucket.org/DasIch/sphinx-version-tracking 2010-08-15 20:50:52 +02:00
Daniel Neuhäuser
c3905938ea Use uuid as a requirement in the setup.py and mention it in the documentation for Python 2.4 2010-08-15 20:48:19 +02:00
Daniel Neuhäuser
ce4c5a63fa merge with lehmannro/sphinx-i18n 2010-08-15 11:55:46 +02:00
Jacob Mason
d11e705182 remove the bogus paragraph I added to docs to test doctree merging 2010-08-14 18:34:01 -05:00
Jacob Mason
34379fedb7 only add node if it doesn't already exist 2010-08-14 18:33:07 -05:00
Jacob Mason
ace0e37e03 fix syntax highlighting in quickstart 2010-08-14 14:48:27 -05:00
Jacob Mason
12584dd257 merge with trunk 2010-08-14 12:16:38 -05:00
Georg Brandl
bafc3ee84d merge with 1.0 2010-08-14 17:08:17 +02:00
Daniel Neuhäuser
023f342bed Removed trailing whitespace 2010-08-10 17:11:11 +02:00
Jacob Mason
ac066fb54a updated docs 2010-08-09 14:22:31 -05:00
Jacob Mason
76fcd457b2 updated docs 2010-08-07 17:04:45 -05:00
Jacob Mason
d08baf4317 merge with trunk 2010-08-07 14:14:21 -05:00
Georg Brandl
861941e5f1 merge with 1.0 2010-08-05 16:20:12 +02:00
Georg Brandl
c683c6ed83 Add some changes not picked up in the transplantation process. 2010-07-28 19:49:06 +02:00
Jacob Mason
7ee4b98fdd merge with trunk 2010-07-27 16:16:40 -05:00
Jacob Mason
58f6271e23 merge with trunk 2010-07-19 11:37:29 -05:00
Jacob Mason
dc4000f4af More docs 2010-07-16 13:31:16 -05:00
Jacob Mason
dc2f45208f separate sqlalchemystorage from __init__ 2010-07-15 13:25:12 -05:00
Jacob Mason
8ff41de37b API tweaks and more documentation 2010-07-13 15:33:12 -05:00
Jacob Mason
77515dee79 added frontend.rst 2010-07-12 12:41:32 -05:00
Jacob Mason
df10a2875e More documentation 2010-07-12 12:15:01 -05:00
Jacob Mason
cf06e98ebd Lots of documentation and a few small API changes 2010-07-12 01:41:39 -05:00
Jacob Mason
42761f6916 Merge with trunk 2010-07-08 21:36:43 -05:00
Jacob Mason
9e569d650a updated documentation 2010-06-26 14:49:30 -05:00
Robert Lehmann
b14658199f Document gettext builder and create i18n docs. 2010-06-26 12:38:06 +02:00
Jacob Mason
eab344496b merge with trunk 2010-06-24 15:04:04 -05:00
Robert Lehmann
cd583b634d merge with trunk 2010-06-23 07:43:07 +02:00
jacob
95d95edacc fixed typo in docs 2010-06-16 08:41:43 -05:00
jacob
3613ce1a42 updated documentation 2010-06-16 08:33:33 -05:00
jacob
ed7c1ad43d Don't add attributes to node. 2010-06-15 22:10:36 -05:00
Roland Meister
603f7e5ec8 Merged with http://bitbucket.org/birkenfeld/sphinx/. 2010-06-14 19:01:20 +02:00
Georg Brandl
187e78adf6 Mention type of "meta". 2010-06-14 09:49:48 +02:00
Georg Brandl
9a0859fea8 Reverse latex appendix logic: Add appendices if docclass is not howto. Also fix docs: other docclasses can be given if you know what you do. 2010-06-12 20:04:01 +02:00
Georg Brandl
c891fdfc60 Document new :py:func:.blah syntax. 2010-06-12 11:37:56 +02:00
Georg Brandl
09e6001e7a In the Python domain, references like `:func:.name``` now look for 
matching names with any prefix if no direct match is found.
 2010-06-12 10:41:56 +02:00
jacob
8e8fd9ca98 Now serves static body. 2010-06-07 16:09:19 -05:00
Roland Meister
13adb67063 Correct handling of extensions for extra files 2010-06-07 22:28:48 +02:00
Roland Meister
d54377153a Only add refnodes with a class of 'toctree-l%d' to the toc.ncx file 2010-06-07 22:27:13 +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
Georg Brandl
0320c3393c Added Danish translation, thanks to Hjorth Larsen. 2010-06-05 15:42:18 +02:00
jacob
65ac358d80 rough documentation 2010-06-04 16:13:53 -05:00
Roland Meister
87c3052bb4 Added note for large floating divs to the documentation. 2010-06-03 15:57:38 +02:00
Roland Meister
ef63485c6e Added one more epub_exclude_file. 2010-06-03 15:39:24 +02:00
Robert Lehmann
a1932f62f0 Add gettext builder to Sphinx docs. 2010-05-30 17:02:54 +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
Georg Brandl
35f0b555a4 The `toctree callable in templates now accepts a titles_only` keyword argument. 2010-05-30 13:16:26 +02:00
Georg Brandl
f3c706edae The `include` directive now supports absolute paths, which are interpreted as relative to the source directory. 2010-05-30 12:59:42 +02:00
Georg Brandl
0f7072f028 Allow linking to tables just like figures with :ref:. 2010-05-30 12:11:52 +02:00
Georg Brandl
aaa89cbb24 Explain absolute paths in toctree. 2010-05-30 11:58:42 +02:00
Georg Brandl
065fec54f9 Mention more targets in "make help". 2010-05-30 09:06:34 +02:00
Georg Brandl
41e55b92de Add missing targets to Makefile; do not build latex twice for latexpdf target. 2010-05-30 09:02:22 +02:00
Georg Brandl
ac9245de2d Update phony targets. 2010-05-30 08:49:33 +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
8d1235d7ad #419: remove unnecessary mkdir call. 2010-05-26 19:08:15 +02:00
Georg Brandl
c671e81d6c Restore sphinxdoc theme. 2010-05-25 23:59:22 +02:00
Georg Brandl
784e598743 In the default theme, the sidebar can experimentally now be made collapsible using the new `collapsiblesidebar` theme option. 2010-05-24 23:14:35 +02:00
Georg Brandl
6dedbfff21 Mention domains in sphinx-contrib. 2010-05-24 22:59:02 +02:00
Georg Brandl
7df8430f2e Merge with http://bitbucket.org/chrism/sphinx/, add latex_show_pagrefs/latex_show_urls config values. 2010-05-24 15:59:05 +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
f6c74a1319 Rename the extlink roles to avoid confusion between :rstdir: and :rst:dir:. 2010-05-24 13:06:55 +02:00
Georg Brandl
9d3e02d238 Add an example. 2010-05-24 13:05:43 +02:00
Georg Brandl
0238e83013 Merge with http://bitbucket.org/tpowers/sphinx/ (rewriting the external/internal distinction code) 
In HTML output, references now get the class ``internal`` if they are internal to the whole project, as opposed to internal to the current page.

The ``menuselection`` and ``guilabel`` roles now support ampersand accelerators.
 2010-05-24 12:57:07 +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
5b7e794e2b #413: Added a way for intersphinx to refer to named labels in other 
projects, and to specify the project you want to link to.
 2010-05-23 13:06:01 +02:00
Georg Brandl
981f134e15 merge with 0.6 2010-05-23 11:17:03 +02:00
Georg Brandl
866d838156 No need to link to dev docs anymore. 2010-05-23 11:16:48 +02:00
Georg Brandl
e83f6a3ecc Fix file name in example. 2010-05-23 11:16:24 +02:00
Georg Brandl
6bc1ce0527 #395: Update Japanese translation URL. 2010-05-22 14:21:01 +02:00
Georg Brandl
0d4bc53e9e Remove debugging leftover. 2010-05-22 14:18:53 +02:00
Georg Brandl
529d3f5329 #404: Make `\and work properly in the author field of the latex_documents` setting. 2010-05-22 14:15:39 +02:00
Georg Brandl
c8c703805c merge with 0.6 2010-05-22 12:59:18 +02:00
Georg Brandl
d1027d6057 Add json target. 2010-05-22 11:40:52 +02:00
Georg Brandl
f5ede38405 #406: mention rst2pdf integration in intro. 2010-05-22 11:11:32 +02:00
Georg Brandl
ae05fc5570 #416: Added Croatian translation, thanks to Bojan Mihelač. 2010-05-22 10:29:55 +02:00
Georg Brandl
28b337dd0c merge 2010-04-18 09:41:44 +02:00
Georg Brandl
722f9ac329 merge with trunk 2010-04-17 13:00:19 +02:00
Georg Brandl
020410f20b merge with 0.6 2010-04-17 12:57:38 +02:00
Georg Brandl
138fc5f7bd Use appropriate interpolation char. 2010-04-17 12:35:21 +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
Georg Brandl
63289cba33 Rename rst_prologue to rst_prolog and document it. 2010-04-07 13:03:34 +02:00
Georg Brandl
d7f1aeba8c Review changes from http://bitbucket.org/tpowers/sphinx/ and add docs. 2010-04-07 13:02:03 +02:00
Georg Brandl
3a61ec646f #349: Add Turkish translation, thanks to Firat Ozgul. 2010-04-07 11:29:32 +02:00
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
Georg Brandl
b9dd04176f pygments_style for HTML is selected by the theme. 2010-02-19 19:58:35 +01:00
Georg Brandl
68ecaea045 merge with trunk 2010-02-19 10:36:59 +01:00
Georg Brandl
3c89a7475b merge with http://bitbucket.org/rolmei/sphinx-epub/. 2010-02-19 10:20:07 +01:00
Georg Brandl
52698469ac Make docs latex-writable again. 2010-01-17 23:24:40 +01:00
Georg Brandl
1bce0d7e6a Fix some XXXes. 2010-01-17 19:21:04 +01:00
Georg Brandl
538886ab94 A bit of domain documentation. 2010-01-17 19:16:18 +01:00
Georg Brandl
1a7403bed8 Add doc for new doc field syntax. 2010-01-17 19:05:19 +01:00
Georg Brandl
baf0087f3a merge with trunk 2010-01-17 18:29:16 +01:00
Georg Brandl
5a9a454631 Added `needs_sphinx config value and Sphinx.require_sphinx` application API function. 2010-01-17 18:24:35 +01:00
Georg Brandl
31c5290fb8 Clean up conf.py file for the docs. 2010-01-17 18:16:14 +01:00
Georg Brandl
e4f4cd2bf9 merge with trunk 2010-01-17 17:00:37 +01:00
Georg Brandl
744a519c92 Add single-file HTML builder. Closes #151. 2010-01-17 16:48:02 +01:00
Georg Brandl
11089371b1 Simplify makefile. 2010-01-17 15:33:28 +01:00
Georg Brandl
5d40d8bd63 merge with trunk 2010-01-17 14:24:24 +01:00
Georg Brandl
c98236bc61 Finish new doc field handling implementation. 2010-01-17 12:05:44 +01:00
Georg Brandl
f5c08cbb60 First step toward better handling of doc fields. 2010-01-15 00:00:37 +01:00
Georg Brandl
5705adc9d5 Document three new appapi functions. 2010-01-14 22:28:03 +01:00
Georg Brandl
27f85a8dab Fix style inconsistency. 2010-01-14 21:33:30 +01:00
Georg Brandl
e2b5248177 Fix typo. 2010-01-14 20:42:10 +01:00
Georg Brandl
ba13060ebe Fix docs of emit_firstresult(). 2010-01-14 11:18:28 +01:00
Georg Brandl
edb89b1940 Add the "viewcode" extension. 2010-01-13 23:53:01 +01:00
Georg Brandl
cbbae81e8f Add html-collect-pages event. 2010-01-13 23:42:58 +01:00
Georg Brandl
a7d9a4894b merge with 0.6 2010-01-12 23:40:26 +00:00
Georg Brandl
fa00d30daf Add link to rst2pdf generated version. 2010-01-12 21:11:20 +00:00
Georg Brandl
8bb4d4320d merge with 0.6 2010-01-12 10:47:29 +00:00
Roland Meister
a880aa8f70 Added transform for visible links. 2010-01-10 21:14:19 +01:00
Roland Meister
0a1f09c9cf Added the epub_tocdepth configuration option. 2010-01-09 11:19:41 +01:00
Georg Brandl
2a2a66a923 merge with trunk 2010-01-08 18:55:35 +01:00
Georg Brandl
c80f52dfbf Added `tab-width option to literalinclude` directive. 2010-01-08 18:36:58 +01:00
Georg Brandl
c227fc2720 merge with trunk (and remove debugging leftover from test layout.html template) 2010-01-07 21:51:23 +01:00
Georg Brandl
03b9d79b34 Fix compatibility with blocks in the old sidebar scheme: blocks cannot be used in included templates. Deprecate the blocks accordingly. 2010-01-07 21:49:31 +01:00
Georg Brandl
b1c937f0d9 merge with trunk (not working perfectly yet) 2010-01-07 21:41:03 +01:00
Georg Brandl
5e17487b74 merge with trunk 2010-01-07 19:19:58 +01:00
Georg Brandl
cbd75346fd merge with trunk 2010-01-07 19:17:45 +01:00
Georg Brandl
a43738e47a merge with trunk 2010-01-07 19:07:50 +01:00
Georg Brandl
2f09d24472 The `html_sidebars` config value can now contain patterns as keys, and the values can be lists that explicitly select which sidebar templates should be rendered. 
That means that the builtin sidebar contents can be included only selectively.
 2010-01-07 17:56:09 +01:00
Georg Brandl
c9345b33b2 `html_static_path` can now contain single file entries. 
Exclusion of static path files is not yet implemented.

HG: Bitte gib eine Versions-Meldung ein. Zeilen beginnend mit 'HG:' werden entfernt.
HG: Leere Versionsmeldung wird das Übernehmen abbrechen.
HG: --
HG: Benutzer: Georg Brandl <georg@python.org>
HG: branch 'default'
HG: added tests/root/_static/excluded.css
HG: added tests/root/_static/subdir/foo.css
HG: added tests/root/templated.css_t
HG: Geändert CHANGES
HG: Geändert doc/config.rst
HG: Geändert sphinx/builders/html.py
HG: Geändert sphinx/util/__init__.py
HG: Geändert tests/root/_static/README
HG: Geändert tests/root/conf.py
HG: Geändert tests/test_build_html.py
 2010-01-07 16:20:52 +01:00
Georg Brandl
ebe51c181e Add a "how do I do google analytics" entry, thanks tonfa. 2010-01-07 15:33:47 +01:00
Georg Brandl
db5845fccf Sharpen the thumbnails a bit. 2010-01-07 15:10:11 +01:00
Georg Brandl
4b8b3fa631 Fix-up text. 2010-01-07 14:27:37 +01:00
Georg Brandl
368ecbb0fd Added new HTML theme `haiku`, inspired by the Haiku OS user guide. 2010-01-07 14:16:53 +01:00
Georg Brandl
f8ca88ebbd Fix bogus module prefix for template variables. 2010-01-07 13:59:06 +01:00
Georg Brandl
2acec48b86 merge with 0.6 2010-01-06 15:51:30 +01:00
Georg Brandl
6f1a3b5c3f Fix config value names. 2010-01-06 15:51:02 +01:00
Georg Brandl
ab7ac64e1a Add new universal config value `exclude_patterns`, with glob-style exclude patterns. 
This makes the old ``unused_docs``, ``exclude_trees`` and ``exclude_dirnames`` obsolete.
 2010-01-06 15:48:39 +01:00
Georg Brandl
c3c3f739af Remove the deprecated `exclude_dirs` config value. 2010-01-06 15:54:34 +01:00
Georg Brandl
57c2b553ae Add preview images for nature theme. 2010-01-03 19:44:40 +01:00
Georg Brandl
f73cbe8afa merge with 0.6 2010-01-03 19:44:21 +01:00
Georg Brandl
443eb4e594 Add "nature" theme, as used by PIP and distribute. 2010-01-03 19:40:07 +01:00
Georg Brandl
a5f1df6946 Mark code blocks as Python. 2010-01-03 19:38:17 +01:00
Georg Brandl
7bafd3d553 merge with 0.6 2010-01-03 16:04:23 +01:00
Georg Brandl
276fc659b0 #162: add link to sphinx.pocoo.org/latest. 2010-01-03 15:36:51 +01:00
Georg Brandl
c8835d970b Added `alt option to graphviz` extension directives. 2010-01-03 12:02:31 +01:00
Georg Brandl
4d2a052c5f Note about linkcheck builder. 2010-01-03 10:24:49 +01:00
Georg Brandl
ae4a1bbc59 Fix link. 2010-01-03 10:22:03 +01:00
Georg Brandl
d32bd22ae7 #309: The `graphviz` extension can now output SVG instead of PNG 
images, controlled by the ``graphviz_output_format`` config value.
Patch by Henrique Bastos.
 2010-01-02 21:38:27 +01:00
Georg Brandl
faeec5cbbb merge with trunk 2010-01-02 21:03:56 +01:00
Georg Brandl
ed78dc7ff0 merge with 0.6 2010-01-02 20:54:59 +01:00
Georg Brandl
6b13a28c11 Make extlinks more flexible: use string substitution to build the full URL. 2010-01-02 20:51:22 +01:00
Georg Brandl
f4da14806c #310: support exception messages in the `testoutput blocks of the doctest` extension. 
Also add minimal test cases for the doctest extension.
 2010-01-02 14:59:27 +01:00
Georg Brandl
32437e45bd merge with 0.6 2010-01-02 00:49:51 +01:00
Georg Brandl
0de312b96f Direct posting to sphinx-dev is not possible anymore. 2010-01-02 00:09:01 +01:00
Georg Brandl
0745637e69 Correct info about jsmath_path if given relative. 2010-01-01 23:54:45 +01:00
Georg Brandl
47ccbccc62 merge with 0.6 2010-01-01 14:10:48 +01:00
Georg Brandl
f6a56192d1 Happy new year! 2010-01-01 14:09:13 +01:00
Georg Brandl
f3a2854ba9 merge with trunk 2009-12-31 18:40:58 +01:00
Georg Brandl
e5561f9b1b Add cross-reference. 2009-12-29 12:41:35 +01:00
Georg Brandl
24fb46226f Review of epub builder. Add a separate "epub_theme" config value for selecting a different theme. 2009-12-29 12:32:42 +01:00
Georg Brandl
5d0812fb91 merge with trunk 2009-12-28 19:49:57 +01:00
Georg Brandl
f37dcb25da merge with epub fork 2009-12-28 19:00:48 +01:00
Roland Meister
6ced1ce311 Disable embedded css for embedded builders. 
Note: this change also affects all other embedded builders (but only for the Shinx doc itself).
 2009-12-28 17:16:19 +01:00
Roland Meister
eee47685fa Activated html_theme 'epub' 2009-12-28 17:11:15 +01:00
Roland Meister
706e12da65 Initial import from local repository 2009-12-28 17:09:09 +01:00
Georg Brandl
0238b8322d merge with 0.6 2009-12-24 13:32:16 +01:00
Georg Brandl
023b41b391 #296: fix copy-paste oversight. 2009-12-24 13:29:11 +01:00
Georg Brandl
98437cfd28 Fix typo. 2009-12-01 21:04:46 +01:00
Georg Brandl
8533c4cb98 merge with trunk 2009-11-16 15:03:20 +01:00
Georg Brandl
407b41536d merge with trunk 2009-11-09 00:37:42 +01:00
Georg Brandl
5590675955 merge with 0.6 2009-11-09 00:33:49 +01:00
Georg Brandl
598f2dda3a Add link to Japanese translation of the docs. 2009-11-08 19:36:16 +01:00
Georg Brandl
77c5026198 Add link to matplotlib's sampledoc, because I suck at writing tutorials. 2009-11-08 18:20:53 +01:00
Georg Brandl
adad88b429 Add notes on rst2pdf pdf builder. 2009-11-08 16:54:06 +01:00
Georg Brandl
4652c53a82 Add examples for graph options. 2009-11-08 10:18:35 +01:00
Georg Brandl
39a9330fc0 Fix autosummary_generate docs; a boolean value is supported only as of trunk. 2009-10-27 20:03:48 +01:00
Georg Brandl
d12ad380f2 Finish renaming description units to object (description)s. 2009-10-27 19:58:40 +01:00
Georg Brandl
13478a4986 Make "make check" happy. 2009-10-26 09:56:14 +01:00
Georg Brandl
4f63b6cbd5 merge with 0.6 2009-10-26 09:46:04 +01:00
Georg Brandl
2942a6f723 Fix whitespace. 2009-10-26 09:45:50 +01:00
Georg Brandl
a51e3a4129 Add missing extension. 2009-10-08 09:14:01 +02:00
Georg Brandl
6b772c5640 merge with trunk 2009-09-09 21:57:49 +02:00
Georg Brandl
b51ed6d25d merge with 0.6 2009-09-09 19:18:48 +02:00
Georg Brandl
66c254c582 copy over autosummary docs from trunk. 2009-09-09 19:18:02 +02:00
Georg Brandl
290a623669 Note that member docstrings need to be reST as well. 2009-09-09 19:10:24 +02:00
Georg Brandl
87cf9675c8 Fix markup. 2009-09-09 18:27:59 +02:00
Georg Brandl
c3b8e3fdf0 Clarify docs of automodule options. 2009-09-09 18:26:59 +02:00
Georg Brandl
0792ad7498 The `toctree() callable in templates now has a maxdepth` 
keyword argument to control the depth of the generated tree.

Also add tests for that callable.
 2009-09-09 15:56:52 +02:00
Georg Brandl
eff5270219 Add pointer to `toctree()` in FAQ. 2009-09-09 15:43:58 +02:00
Georg Brandl
023cae4e47 Add link to sphinx-pypi-upload package. 2009-09-09 11:00:54 +02:00
Georg Brandl
0136520b7c Add scrolls theme to the docs. 2009-09-08 21:49:27 +02:00
Georg Brandl
efa4678cfd Add some XXX comments to places where work is needed. 2009-09-08 12:07:11 +02:00
Georg Brandl
b4ef4bd670 app: allow giving the localized object name when adding new object types. 2009-09-08 00:04:05 +02:00
Georg Brandl
fa7f8812cd More refactoring for language-independent domain support. 
* Renamed "desc"ription unit to "object" wherever possible.
* Added standard x-ref types to a StandardDomain which is always consulted.
* Split domains module into a subpackage.
* Removed additional_xref_types in favor of new directive classes in StandardDomain.
* Implemented x-ref inventory version 2, for all object types.
* Added env.doc_read_data which is for temporary data stored while reading.
* Minimally updated extension tutorial.
* Started to implement changes to interactive search.
* Test suite passes again.
 2009-09-07 22:52:26 +02:00
Georg Brandl
9fce647b14 merge with 0.6 2009-09-03 18:24:04 +02:00
Georg Brandl
3e91b3cd64 merge 2009-09-02 17:32:48 +00:00
Georg Brandl
a734207eea fix markup 2009-08-26 14:30:23 +00:00
Georg Brandl
d3b0d6a105 merge with trunk 2009-08-09 22:46:16 +02:00
Georg Brandl
137f37b2fc merge with 0.6 2009-08-06 23:03:49 +02:00
Georg Brandl
c32186282f #222: Allow the "Footnotes" header to be translated. 2009-08-06 22:48:14 +02:00
Georg Brandl
3352493642 merge pre-domain state with tip from 0.6 2009-08-06 21:36:57 +02:00
Georg Brandl
86686262bd merge with 0.6 2009-08-05 00:04:39 +02:00
Georg Brandl
0516082799 Add link to db2rst. 2009-08-04 22:39:17 +02:00
Georg Brandl
af8fe705a2 Added Catalan translation, thanks to Pau Fernández. 2009-07-29 16:39:06 +00:00
Georg Brandl
e766c576c0 Put traditional theme at the bottom. 2009-11-16 14:50:51 +01:00
Georg Brandl
c68f51305d Add scrolls theme to the docs. 2009-09-08 21:49:27 +02:00
Georg Brandl
03aaed913b Add new theme "agogo", by Andi Albrecht. 2009-11-16 14:48:52 +01:00
Pauli Virtanen
8122339c95 Add GNOME Devhelp builder 2009-06-27 19:49:51 +03:00
Pauli Virtanen
9043aeb723 autosummary: generate stub pages recursively 2009-06-19 16:57:43 +03:00
Georg Brandl
041d7c37a5 #116: Added `html_output_encoding` config value. 2009-06-16 22:19:51 +02:00
Georg Brandl
0ed845462f #169: Added the `trim_doctest_flags` config value, which is true by default. 2009-06-16 21:53:53 +02:00
Georg Brandl
a6fdc4602a merge with 0.6 2009-06-16 21:32:05 +02:00
Georg Brandl
269345a0f3 Clarify and fix typo. 2009-06-16 21:19:15 +02:00
Georg Brandl
812455e32c #200: Added `Sphinx.add_stylesheet()`. 2009-06-16 21:05:20 +02:00
Georg Brandl
fdf4bf4154 merge with 0.6 2009-06-15 18:36:22 +02:00
Georg Brandl
8820e99440 Added `titlesonly option to toctree` directive. 2009-06-15 18:05:07 +02:00
Georg Brandl
61a55f095b Remove misguided recommendation to use emphasis for variables. 2009-06-15 17:43:32 +02:00
Georg Brandl
7d56682ad7 merge with 0.6 2009-06-15 17:33:56 +02:00
Georg Brandl
f3860b1af9 Update URL for html2rest. 2009-06-10 08:45:22 +02:00
Georg Brandl
279dd4fa41 Builder.load_env is no more. 2009-07-26 15:00:18 +02:00
Georg Brandl
43f475b74e Fix long lines. 2009-07-05 12:28:45 +02:00
Georg Brandl
c02b7149aa Move domain-specific code around a bit; builtin domains are now completely in sphinx.domains. Test suite does not pass yet. 2009-07-05 12:24:27 +02:00
Georg Brandl
4e535fec91 #193: Added a `visitedlinkcolor` theme option to the default theme. 2009-06-05 10:41:02 +02:00
Georg Brandl
fb0791bdfc Added the `prepend and append` options to the 
``literalinclude`` directive.
 2009-06-04 17:57:58 +02:00
Georg Brandl
ebcf18d9c3 Added the `latex_docclass` config value and made the "twoside" 
documentclass option overridable by "oneside".
 2009-06-04 17:50:37 +02:00
Georg Brandl
df75924602 merge with 0.6 2009-05-31 18:59:36 +02:00
Georg Brandl
92eef1b2e5 Set the default encoding to `utf-8-sig` to handle files with a 
UTF-8 BOM correctly.
 2009-05-31 18:58:28 +02:00
Georg Brandl
7749debcdc Reformat autosummary docs. 2009-05-17 12:29:38 +02:00
Georg Brandl
8bb67b9bf0 merge with 0.6 2009-05-17 12:24:17 +02:00
Georg Brandl
0a3d0495a1 merge with pv/sphinx-work 2009-05-17 12:24:04 +02:00
Georg Brandl
d2bdbb0ee5 #168: fix code. 2009-05-17 12:20:04 +02:00
Georg Brandl
95dbaa5360 merge with 0.6 2009-05-16 12:49:58 +02:00
Pauli Virtanen
472357e6a5 autosummary: allow user to override stub templates + improve the default templates 2009-05-15 00:22:30 +03:00
Pauli Virtanen
bbf4fe36c1 autosummary: accept 'autosummary_generate = True' in config files 2009-05-14 22:01:19 +03:00
Georg Brandl
92f420bd22 Add more interop links. 2009-05-13 09:15:29 +02:00
Georg Brandl
041a491df7 Remove testing leftover. 2009-05-03 10:36:27 +02:00
Georg Brandl
6702234eac Remove testing markup. 2009-05-03 10:25:40 +02:00
Georg Brandl
40a044b6da Fix markup. 2009-05-03 10:24:28 +02:00
Georg Brandl
e46e989d8b No need to use extlinks in conf.py. 2009-05-02 20:48:30 +02:00
Georg Brandl
58da7a84fd Added the `extlinks` extension. 2009-05-02 20:38:45 +02:00
Georg Brandl
7e53d3f71b Next version will be 1.0. 2009-04-29 12:55:03 +02:00
Georg Brandl
2376d259ef Added simplified Chinese locale. 2009-04-28 23:21:07 +02:00
Georg Brandl
7468998a28 merge with 0.6 2009-04-28 21:43:40 +02:00
Georg Brandl
770f716fc0 #29: Don't generate visible "-{-}" in option lists in LaTeX. 2009-04-28 21:28:29 +02:00