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,043 Commits 2 Branches 219 Tags 163 MiB
0248416c65
Commit Graph

298 Commits

Author SHA1 Message Date
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
Georg Brandl
733b2b5bc6 Automated merge with file:///home/gbr/devel/sphinx0.5 2008-12-07 22:36:44 +01:00
Georg Brandl
8c055e8004 Document that mathbase isn't meant to be included in the extensions config 
value.
 2008-12-06 23:26:34 +01:00
Georg Brandl
50339493c6 Add Sphinx.add_lexer(). 2008-11-30 19:58:29 +01:00
Georg Brandl
bd12a8e547 Some more fixes after the great renaming. 2008-11-29 20:04:11 +01:00
Georg Brandl
404625e718 Fix param name and add example. 2008-11-23 17:08:19 +01:00
Georg Brandl
b1579af47e A few math experience improvements, inspired by Fredrik Johansson. 2008-11-16 18:44:46 +01:00
Georg Brandl
0060e50efa Add todo extension. 2008-11-09 19:46:32 +01:00
Georg Brandl
7b62fc8f2d Add env-purge-doc event. Add some examples for event usage. 2008-11-09 11:56:40 +01:00
Georg Brandl
155411a93d Allow skipping members by event. 2008-11-02 20:04:24 +00:00
Georg Brandl
f74f8ca7a4 Bring up to date and link to add_config_value(). 2008-11-01 14:54:51 +00:00
Georg Brandl
d7e2a48555 Add "source-read" event. 2008-10-16 19:04:45 +00:00
Georg Brandl
aed6d94008 Allow nonwrapped displaymath. 2008-08-07 09:17:50 +00:00
Georg Brandl
6d89feae1e Test suite update for math extension. 2008-08-06 14:57:44 +00:00
Georg Brandl
5941814c4a Add math support to Sphinx. 2008-08-06 13:04:14 +00:00
Georg Brandl
b7b483d01f `Sphinx.add_node()` now takes optional visitor methods for the HTML, 
LaTeX and text translators; this prevents having to manually patch
the classes.
 2008-08-05 10:25:40 +00:00
Georg Brandl
b4c78df0a2 Add intersphinx extension. 2008-08-04 17:31:25 +00:00
Georg Brandl
97558dcc06 Add "env-updated" and "missing-reference" events. 
Write inventory file as part of the HTML build.
 2008-08-04 09:54:45 +00:00
Georg Brandl
b4f91a5ce5 #3422: allow changing the signature of functions via a new hook. 2008-07-29 18:30:23 +00:00
Georg Brandl
aa74c0b799 automodule now supports module options. 2008-07-08 14:45:44 +00:00
Georg Brandl
2e698fcb09 Merged revisions 64642-64643,64698 via svnmerge from 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r64642 | georg.brandl | 2008-07-01 23:02:35 +0200 (Tue, 01 Jul 2008) | 2 lines

  #3251: label names are case insensitive.
........
  r64643 | georg.brandl | 2008-07-01 23:24:55 +0200 (Tue, 01 Jul 2008) | 2 lines

  Add a note about decorated functions.
........
  r64698 | georg.brandl | 2008-07-04 12:21:09 +0200 (Fri, 04 Jul 2008) | 2 lines

  Allow setting current module to None.
........
 2008-07-04 14:27:25 +00:00
Georg Brandl
c1bedfc105 Add general docstring processing support with a new event in autodoc. 2008-06-22 21:02:50 +00:00
Georg Brandl
7c2247f880 Support :noindex: in autodoc directives. 2008-06-22 17:58:05 +00:00
Georg Brandl
002837d7f7 Fix class name. 2008-06-18 18:46:46 +00:00
Georg Brandl
309377fbbf Support inheritance display in autoclass, thanks to mdboom. 2008-06-17 09:24:11 +00:00
Georg Brandl
2b0e015fcc Add html-page-context event for customizing the template context. 2008-05-31 16:14:36 +00:00
Georg Brandl
02b529bf52 Add html_short_title and html_show_sphinx config values. 2008-05-24 18:03:56 +00:00
Georg Brandl
0e3dd509e6 Clarify docs for auto directive options. 2008-05-23 13:57:48 +00:00
Georg Brandl
0bcc9d4655 Minor enhancements to generate_rst. 2008-05-06 18:23:36 +00:00
Armin Ronacher
6e0c582a7b added support for explicit signatures in callables 2008-05-06 18:07:17 +00:00
Georg Brandl
5ed30072e3 Rename version to 0.3. 2008-05-04 17:57:11 +00:00
Georg Brandl
d93b236545 #2726: allow selecting what gets inserted into an autoclass directive. 2008-05-04 09:37:37 +00:00
Georg Brandl
a9d35e3c54 #2656: autodoc now skips inherited members unless the :inherited-members: flag is given. 2008-05-04 09:07:51 +00:00
Georg Brandl
5caa6d01c5 * New LaTeX table handling. 
* Support parts in LaTeX output.
 2008-05-03 18:14:13 +00:00
Georg Brandl
ae8813c788 Add new templating API, remove Jinja external and add it to setup.py dependencies. 2008-04-13 18:16:55 +00:00
Georg Brandl
be080234bb Support Sphinx.add_transform(). 2008-04-13 08:20:11 +00:00
Georg Brandl
2571218ab9 Add note about __module__ checking. 2008-04-13 08:09:07 +00:00
Georg Brandl
5fe73576a5 Support app.add_crossref_type(). 2008-03-28 18:45:32 +00:00
Georg Brandl
2da5b3df46 Expand on the pickle builder. 2008-03-25 19:20:26 +00:00
Georg Brandl
5d272bdd0d Make sphinx compatible with docutils SVN snapshots. 2008-03-23 15:07:15 +00:00
Georg Brandl
8be320821a Add versionadded tag. 2008-03-23 08:33:20 +00:00
Georg Brandl
7111855bab Also remove # doctest: directives in presentation output. 2008-03-22 21:21:28 +00:00
Georg Brandl
b82b162729 * sphinx.ext.doctest: Replace <BLANKLINE> in doctest blocks by 
real blank lines for presentation output.
* sphinx.environment: Move doctest_blocks out of block_quotes to
  support indented doctest blocks.
 2008-03-22 21:10:35 +00:00
Georg Brandl
fa089ae583 Add note about blank lines in doctest blocks. 2008-03-22 20:47:27 +00:00
Georg Brandl
3155163249 Put doctests in "default" by default and update docs for doctest extension. 2008-03-22 13:07:22 +00:00
Georg Brandl
49be523051 Add license and repository info to front page, add comments where sections need to be written. 2008-03-21 18:59:28 +00:00
Georg Brandl
77441d7549 * Add docs for sphinx.ext.doctest. 
* Update parse_node functions.
 2008-03-21 14:06:04 +00:00
Georg Brandl
39e8da70b9 Fill in some XXXs. 2008-03-18 18:19:21 +00:00
Georg Brandl
ca528099f6 Update documentation, add more content. 2008-03-16 11:19:26 +00:00
Georg Brandl
f2d713c577 Add documentation for autodoc. 2008-03-14 23:35:08 +00:00
Georg Brandl
6d7d1f6e50 Some more documentation. 2008-03-12 21:37:22 +00:00