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,256 Commits 2 Branches 219 Tags 163 MiB
ec453b94e7
Commit Graph

891 Commits

Author SHA1 Message Date
Georg Brandl
103f258d83 #497: Introduce separate background color for the sidebar collapse button, making it easier to see. 2010-08-23 16:11:26 +00:00
Georg Brandl
ab334a2a6f Fix sectioning. 2010-08-23 15:58:26 +00:00
Georg Brandl
9d7b75aa5d Clarify example. 2010-08-19 00:02:26 +02:00
Roland Meister
004d706004 Added epub_cover configuration option. 2010-08-06 22:50:41 +02:00
Roland Meister
85a63e297e Empty titles in epub_pre/post_files add no entry in toc.ncx. 2010-08-05 23:08:55 +02:00
Roland Meister
7a41ec29b8 Empty titles in epub_pre/post_files add no entry in toc.ncx. 2010-08-05 23:08:55 +02:00
Georg Brandl
7518d19437 #469: document __all__ ordering in members. 2010-08-05 18:59:04 +02:00
Georg Brandl
df107e70f8 Allow breaking long signatures, continuing with backlash-escaped newlines. 2010-08-05 16:03:36 +02:00
Georg Brandl
92142bbdb6 Allow references to PEPs and RFCs with explicit anchors. 2010-08-05 15:42:15 +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
01c501054e #480: Fix handling of target naming in intersphinx. 2010-08-05 11:58:43 +02:00
Georg Brandl
cb26c78079 Describe the "deprecated" directive. 2010-07-29 09:27:46 +02:00
Georg Brandl
13017eecc8 Go to #pocoo. 2010-07-28 14:53:39 +02:00
Georg Brandl
2380957682 #266: Add Bengali locale, thanks to Nasimul Haque. 2010-07-27 14:36:47 +02:00
Georg Brandl
5fd37f16e4 merge with bb:rolmei/sphinx-epub. 2010-07-22 15:04:22 +01:00
Georg Brandl
e7405554a7 Adjust alignment. 2010-07-17 19:52:54 +02:00
Georg Brandl
2b29038d0c The behavior of :confval:html_file_suffix changed slightly: the empty string now means "no suffix" instead of "default suffix", use `None` for "default suffix". 2010-07-17 19:45:54 +02:00
Georg Brandl
400617e692 #461: elaborate how to use intersphinx. 2010-07-10 16:59:23 +02:00
Georg Brandl
d0900e8862 #465: update version requirement. 2010-07-10 16:50:32 +02:00
Roland Meister
7cbe0588a9 Added new config parameter epub_tocdup. 2010-07-10 16:33:43 +02:00
Roland Meister
0dd1e93bed Merge with http://bitbucket.org/birkenfeld/sphinx 2010-06-30 21:34:35 +02:00
Georg Brandl
bd1c19d724 Added Lithuanian translation, thanks to Dalius Dobravolskas. 2010-06-20 12:19:34 +02:00
Georg Brandl
f5ecd62d05 #537: Added :confval:nitpick_ignore. 2011-01-08 18:36:52 +01:00
Georg Brandl
1961a4aaa8 Fix typo in name. 2011-01-08 18:06:38 +01:00
Georg Brandl
c266128c6d Rename "intl" module to "gettext", to make it easier to find. Distinguish environments with different versioning methods and always give the gettext builder its own doctree dir. 2011-01-08 17:32:32 +01:00
Georg Brandl
e48f7eb09a Fix interpolation error, encode inserted caption strings and add the caption in HTML output too. 2011-01-08 15:39:35 +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
d3ab0abce6 merge with 1.0 2011-01-08 00:11:37 +01:00
Georg Brandl
30f85dab6e #367: Added automatic exclusion of hidden members in inheritance diagrams, and an option to selectively enable it. 2011-01-07 22:35:57 +01:00
Georg Brandl
5c39cfb6e9 merge with 1.0 2011-01-07 19:04:53 +01:00
Georg Brandl
bf767d5222 #454: Add more index markup capabilities: marking see/seealso entries, and main entries for a given key. 2011-01-07 19:00:29 +01:00
Georg Brandl
98d884da6e #306: Added :event:env-get-outdated event. 2011-01-07 16:41:44 +01:00
Georg Brandl
763789463d merge with 1.0 2011-01-06 20:59:33 +01:00
Georg Brandl
f925de6aa0 #586: Implemented improved glossary markup which allows multiple terms per definition. 2011-01-06 20:34:41 +01:00
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