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

300 Commits

Author SHA1 Message Date
Georg Brandl
c333f515cd Doc change for d7ac5e46307d 2012-05-08 12:51:28 +02:00
Georg Brandl
fe8ed35dfb Make it clearer how autodoc special comments have to be formatted. 2012-03-17 16:54:17 +01:00
Georg Brandl
53d06fda7b Closes #793: Fix docutils version references. 2011-11-01 09:16:37 +01:00
Georg Brandl
9a4a3c9afa Satisfy "make check". 2011-10-09 23:09:57 +02:00
Georg Brandl
e74a5541df Make it clear that math labels are internal. 2011-09-21 10:21:22 +02:00
Georg Brandl
ed0bad3889 Doc and changelog entries for 91b4fc984b32. 2011-07-23 10:04:09 +02:00
Georg Brandl
680d261694 s/jsmath/mathjax/ 2011-07-23 10:02:04 +02:00
bond
bfa6e8c0de some changes to math docs 2011-07-19 22:35:52 +02:00
Pauli Virtanen
e1be6ef8f8 autosummary: minor doc clarifications 2011-06-29 21:27:43 +02:00
Georg Brandl
99c505b63f Closes #683: set default MathJax path to the CDN URL, and update the docs accordingly. 2011-05-15 11:57:23 +02:00
Daniel Neuhäuser
e46a8e9ded Change redirected URLs to the new locations 2011-02-05 21:48:54 +01:00
Georg Brandl
a63230f12d #431: Doc comments for attributes can now be given on the same line as the assignment. 2011-01-15 15:40:59 +01:00
Georg Brandl
6e2324ab2c Add changelog entry and docs for #594. 2011-01-09 21:43:22 +01:00
Georg Brandl
87b0ac63ed merge with 1.0 2011-01-09 00:47:48 +01:00
Georg Brandl
b89e9b4346 Clarification. 2011-01-08 23:50:03 +01:00
Georg Brandl
bc6b586836 Added :confval:pngmath_add_tooltips. 2011-01-08 19:08:38 +01:00
Georg Brandl
210add8d2c Parse parmeter field in event descriptions. 2011-01-07 16:27:47 +01:00
Georg Brandl
7e5ff71c40 #513: Allow giving non-local URIs for JavaScript files, e.g. in the JSMath extension. 2010-08-25 10:26:15 +00:00
Georg Brandl
7518d19437 #469: document __all__ ordering in members. 2010-08-05 18:59:04 +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
400617e692 #461: elaborate how to use intersphinx. 2010-07-10 16:59:23 +02: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
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
98d884da6e #306: Added :event:env-get-outdated event. 2011-01-07 16:41:44 +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
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
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
92f6212c98 Add add_node() support for texinfo and add handlers for nodes in our extensions. 2010-10-22 11:16:23 +02:00
Chris Rebert
ef62d317e5 autodoc's docstring/special-comment detection works for instance attributes too 2010-10-02 00:05:59 -07:00
Doug Hellmann
4a00029a43 add 'inline' flag to graphviz extension directives to control paragraph breaks 2010-09-16 09:29:04 -04:00
Georg Brandl
3ddd7d9075 merge with 1.0 2010-08-25 12:02:59 +00:00
Georg Brandl
9c2747da91 #443: Allow referencing external graphviz files. 2010-08-23 13:07:28 +00:00
Georg Brandl
4d0facf1e1 Add the "oldcmarkup" extension, to help migrating to 1.0. 2010-05-24 15:12:27 +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
722f9ac329 merge with trunk 2010-04-17 13:00:19 +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
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
aa08703a07 Fix file name where example docs are located. 2010-04-04 19:04:01 +02:00
Georg Brandl
1ea64352fe A bit more tutorial. 2010-03-14 19:46:54 +01:00
Georg Brandl
04f660d021 Change domain-index API: introduce a class. 2010-02-28 14:45:43 +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
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
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
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
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
5705adc9d5 Document three new appapi functions. 2010-01-14 22:28:03 +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
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
f8ca88ebbd Fix bogus module prefix for template variables. 2010-01-07 13:59:06 +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
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
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
0745637e69 Correct info about jsmath_path if given relative. 2010-01-01 23:54:45 +01:00
Georg Brandl
5d0812fb91 merge with trunk 2009-12-28 19:49:57 +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
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
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
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
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
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
Pauli Virtanen
9043aeb723 autosummary: generate stub pages recursively 2009-06-19 16:57:43 +03: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
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
7749debcdc Reformat autosummary docs. 2009-05-17 12:29:38 +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
40a044b6da Fix markup. 2009-05-03 10:24:28 +02:00
Georg Brandl
58da7a84fd Added the `extlinks` extension. 2009-05-02 20:38:45 +02:00
Georg Brandl
97ebfba6c8 Make doctest block definition clearer. 2009-04-27 17:34:27 +02:00
Georg Brandl
4d249fa3e4 Fix a few stylistic things, and add docs for autosummary_generate. 2009-04-13 08:40:56 +00:00
Pauli Virtanen
d9ae7c30cb autosummary: write documentation 2009-04-04 22:05:04 +03:00
Pauli Virtanen
73ae2f9c94 Some autosummary fixes 2009-03-21 00:34:46 +02:00
Sebastian Wiesner
73942678c8 #122: proxy support for intersphinx 2009-03-19 15:49:03 +01:00
Georg Brandl
338312dd61 Add autosummary doc stub. 2009-03-16 01:30:09 +01:00
Georg Brandl
e517911ac3 Autodoc can now exclude single members from documentation 
via the ``exclude-members`` option.
 2009-03-15 23:52:48 +01:00
Georg Brandl
a77888a42b Document setup_extension(). 2009-03-14 21:34:59 +01:00
Georg Brandl
d117ef45a3 Fix node class name. 2009-03-09 09:47:10 +01:00
Georg Brandl
fc30eea875 Update tutorial for directive classes. 2009-03-07 22:54:36 +01:00
Georg Brandl
9951bd3f73 Make titles consistent. 2009-03-05 00:17:14 +01:00
Georg Brandl
c5d0ba9913 New `inheritance_diagram` extension to embed... inheritance diagrams! 2009-03-05 00:14:29 +01:00
Georg Brandl
75637a5d6a New `graphviz` extension to embed graphviz graphs. 2009-03-04 23:52:56 +01:00
Georg Brandl
43dc531458 Fix grammar. 2009-03-04 23:49:32 +01:00
Georg Brandl
d2d3606158 Autodoc can now order members either alphabetically (like previously) or by member type; 
configurable either with the config value ``autodoc_member_order`` or a ``member-order`` option per directive.

Also fix a bug that documented module-level functions as attributes.
 2009-02-27 15:48:41 +01:00
Georg Brandl
dd32405563 Remove docs for removed automodule_skip_lines setting. 2009-02-27 15:22:45 +01:00
Georg Brandl
0c70b1caa0 Remove removed method. 2009-02-21 22:01:27 +01:00
Georg Brandl
1d128f57fa Fix #106, fix #107: make _special_attrgetters an attribute of AutoDirective, to avoid confusion how it should be overridden in subclasses. 2009-02-19 22:54:34 +01:00
Georg Brandl
d4f5796f3b The HTML builder now stores a small file named `.buildinfo` in 
its output directory.  It stores a hash of config values that
can be used to determine if a full rebuild needs to be done (e.g.
after changing ``html_theme``).
 2009-02-19 16:15:36 +01:00
Georg Brandl
219fdd282d Add node structure picture. 2009-02-18 00:17:28 +01:00
Georg Brandl
8777c34779 Add link to docutils directive docs. 2009-02-18 00:13:12 +01:00
Georg Brandl
30fd6faddd Document changes to the app API. 2009-02-17 19:33:46 +01:00
Georg Brandl
10c89799fd Fix #93: note that show-inheritance works with automodule. 2009-02-15 18:52:28 +01:00
Georg Brandl
1219e3e73a merge with main 2009-02-14 23:25:30 +01:00
Georg Brandl
36b21d0570 Clarify what needs to be added to extensions. 2009-02-07 20:38:56 +01:00
Georg Brandl
d1e6119461 merge with trunk 2009-01-26 22:44:38 +01:00
Georg Brandl
bb291e5045 Add add_generic_role(). 2009-01-22 20:01:01 +01:00
Georg Brandl
55c4f5a096 merge with trunk 2009-01-22 19:25:24 +01:00
Georg Brandl
29cc19a199 merge with 0.5 2009-01-22 19:23:23 +01:00
Georg Brandl
05cf79da52 A bit of clarification about where Sphinx finds autodoced modules. 2009-01-22 19:22:49 +01:00
Georg Brandl
aedbdd953d Fix more line length and trailing whitespace. 2009-01-10 22:18:18 +01:00
Georg Brandl
34a08b862e Document how autodoc with attributes works. 2009-01-06 00:28:29 +01:00
Georg Brandl
83c9f7a849 Improve builder docs a bit. 2008-12-26 20:17:59 +01:00
Georg Brandl
f4b1bb7b9e Automated merge with file:///home/gbr/devel/sphinx0.5 2008-12-21 00:11:04 +01:00
Georg Brandl
1050c9bca5 Fix #58: Add extension tutorial and better docs on where to put extensions. 2008-12-21 00:10:47 +01:00
Georg Brandl
a605255413 Automated merge with file:///home/gbr/devel/sphinx0.5 2008-12-15 19:31:12 +01:00
Georg Brandl
1dc46e6583 * #72: In pngmath, make it possible to give a full path to LaTeX and 
dvipng on Windows.  For that to work, the ``pngmath_latex`` and
  ``pngmath_dvipng`` options are no longer split into command and
  additional arguments; use ``pngmath_latex_args`` and
  ``pngmath_dvipng_args`` to give additional arguments.
 2008-12-15 19:24:34 +01:00
Georg Brandl
5066f49fbe Add "doctest_global_setup" conf val. 2008-12-15 12:33:13 +01:00