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
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
242e343c10 Follow renaming of desc_classname to desc_addname. 2008-06-18 18:33:11 +00:00
Georg Brandl
7d4ce97ec3 Add default_role configuration value. 2008-06-17 10:06:37 +00:00
Georg Brandl
309377fbbf Support inheritance display in autoclass, thanks to mdboom. 2008-06-17 09:24:11 +00:00
Georg Brandl
6b5f4f198a Support splitting the HTML index. 2008-06-17 09:01:26 +00:00
Georg Brandl
1f73e1bee9 Add notes about Unicode and escaping of backslashes. 2008-06-17 07:46:33 +00:00
Georg Brandl
b05861454c Add image format handling. 2008-06-15 14:31:16 +00:00
Georg Brandl
66b5f39bc7 Add html_favicon config value. 2008-06-15 08:48:06 +00:00
Georg Brandl
bd4166c2d6 Add maxdepth for TOCs. 2008-06-12 21:56:06 +00:00
Georg Brandl
a5523402eb Add a preliminary text writer, mainly for producing pydoc-compatible topic help. 2008-06-01 15:27:16 +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
0cf8cc2c5d Provide rest "class" directive as "cssclass". 2008-05-24 19:29:20 +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
28c3199018 Allow subdirs in html_static_path. 2008-05-24 16:40:11 +00:00
Georg Brandl
5eaf2eb29a Add exclude_trees config value. 2008-05-24 16:28:06 +00:00
Georg Brandl
d7fcfb76f8 #2904: fix :func:title <target> behavior. 2008-05-24 16:18:54 +00:00
Georg Brandl
e93f22e84e Add html_use_index flag. 2008-05-23 14:01:53 +00:00
Georg Brandl
0e3dd509e6 Clarify docs for auto directive options. 2008-05-23 13:57:48 +00:00
Georg Brandl
a72511e770 Fix determination of title in HTML help. 2008-05-23 13:41:14 +00:00
Georg Brandl
4a6d98a3fa Add examples section. 2008-05-06 22:21:12 +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
cc6b4ee1ec Add html_file_suffix value. 2008-05-06 14:25:29 +00:00
Georg Brandl
de0bd87731 Support all rst admonitions in LaTeX. 2008-05-06 07:21:46 +00:00
Georg Brandl
9fc2a9b7ad Add `toctree_only` feature to LaTeX builder. 2008-05-04 21:35:03 +00:00
Georg Brandl
5ed30072e3 Rename version to 0.3. 2008-05-04 17:57:11 +00:00
Georg Brandl
3761223d85 * Support for C class names (and const specifiers). 
* Fix handling of describe environment.
 2008-05-04 17:55:35 +00:00
Georg Brandl
548cdc858a Add globbing-style toctree entries. 2008-05-04 16:57:15 +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
f404b36a0e Fix handling of Verbatim within tables. 2008-05-04 07:43:09 +00:00
Georg Brandl
eeb8a4b27e Use correct OpenSearch base url. 2008-05-03 20:18:53 +00:00
Georg Brandl
06b9960719 Fix OpenSearch description generation. 2008-05-03 20:15:25 +00:00
Georg Brandl
5caa6d01c5 * New LaTeX table handling. 
* Support parts in LaTeX output.
 2008-05-03 18:14:13 +00:00
Georg Brandl
4badbc4f8d Remove note about 0.1. 2008-05-03 09:43:10 +00:00
Georg Brandl
e2158213e8 Allow the configuration directory to be set differently from the source directory. 
Also don't import docutils on importing sphinx.
 2008-05-02 10:32:08 +00:00
Georg Brandl
7ad49d5756 Add exclude_dirs config value. 2008-05-02 09:15:59 +00:00
Georg Brandl
9050ba428e Increase version number. Explain "fully qualified" in the config docs. 2008-05-02 09:05:30 +00:00
Georg Brandl
f91b87b14f Fix typo. 2008-04-28 13:45:58 +00:00
Armin Ronacher
aca631b58f documented change 2008-04-28 13:25:01 +00:00
Georg Brandl
db259e24a4 Put version number in index sidebar. 2008-04-27 20:13:56 +00:00
Georg Brandl
0ee5e39253 Fetch Sphinx version from Sphinx itself. 2008-04-27 20:12:41 +00:00
Georg Brandl
262edb1413 Add logo options, add blocks to sidebar. 2008-04-27 19:43:45 +00:00
Georg Brandl
f7f2cf3a81 Fix markup. 2008-04-27 18:10:48 +00:00
Georg Brandl
0fba8f435e Use OpenSearch for Sphinx docs. 2008-04-27 18:09:49 +00:00
Georg Brandl
a7d088d75b Add OpenSearch capability. 2008-04-27 18:08:55 +00:00
Georg Brandl
1ba3902225 Review templating docs. 2008-04-27 16:35:55 +00:00
Armin Ronacher
ed68fefabe simplified layout template a bit, working on templating documentation 2008-04-27 14:23:11 +00:00
Georg Brandl
e68947dae4 Add a para about section nesting. 2008-04-26 18:01:42 +00:00
Georg Brandl
ec04b2f4ff * Use a customizable title for the docs. 
* Fix up the clumsy index template handling.
 2008-04-19 21:28:24 +00:00
Georg Brandl
c5a4ebe008 :func: et al. should not include parens. 2008-04-19 17:00:31 +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
9e485e078e Support `currentmodule` directive, for docs that spread documentation 
for a module's contents over multiple files.
 2008-04-13 17:57:14 +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
11f63acd22 Fix :term:title <target>, and make giving multiple cmdoptions possible. 2008-04-07 05:19:26 +00:00
Georg Brandl
7dd56497af Advise to put index directives before the target. 2008-04-06 17:41:51 +00:00
Georg Brandl
ea2f87fc03 Allow the config to act as an extension. 2008-04-06 17:38:55 +00:00
Georg Brandl
b016896c1c Don't swallow toc entries when resolving subtrees. 2008-04-06 16:47:28 +00:00
Georg Brandl
b8369b5c81 Allow new titles in the toctree. 2008-03-30 06:36:20 +00:00
Georg Brandl
d8b8412c84 Adapt extension mod to new indextemplate syntax. 2008-03-28 18:50:03 +00:00
Georg Brandl
5fe73576a5 Support app.add_crossref_type(). 2008-03-28 18:45:32 +00:00
Georg Brandl
eaea91ff39 Add subscription box for the google group. 2008-03-28 13:04:05 +00:00
Georg Brandl
980d22b1a7 Fix HTML. 2008-03-28 07:26:32 +00:00
Georg Brandl
e7dad27b53 Refer to the new Google group. 2008-03-28 07:25:46 +00:00
Georg Brandl
0e1befa4a9 Several fixes in the latex processing. 2008-03-26 12:16:59 +00:00
Georg Brandl
7e2fa2c066 Add a paragraph on special names. 2008-03-25 19:57:09 +00:00
Georg Brandl
2da5b3df46 Expand on the pickle builder. 2008-03-25 19:20:26 +00:00
Georg Brandl
d2ee24fb2f Add Jabber address. 2008-03-25 18:34:11 +00:00
Georg Brandl
aa9ba35f23 Rename pickle builder target. 2008-03-25 18:31:06 +00:00
Georg Brandl
8057b0f80e Rebuild all HTML files in case of a template change. 
Also, record image docnames in order to be able to delete image records from the env.
 2008-03-25 15:22:25 +00:00
Georg Brandl
ba47f283f6 Support the image directive. 2008-03-25 12:32:03 +00:00
Georg Brandl
f264cb6679 Add the changelog to the documentation. 2008-03-23 21:25:19 +00:00
Georg Brandl
08d86db91c Add changelog entry and docs for builder rename. 2008-03-23 19:40:17 +00:00
Georg Brandl
325750aa76 Refer to bugs.python.org. 2008-03-23 17:45:16 +00:00
Georg Brandl
5a131c30a2 Don't install scripts twice. Thanks to lunar. 2008-03-23 17:43:22 +00:00
Georg Brandl
bf3e2cc208 Refreshed logo, by Panos Laganakos. 2008-03-23 15:08:57 +00:00
Georg Brandl
5d272bdd0d Make sphinx compatible with docutils SVN snapshots. 2008-03-23 15:07:15 +00:00
Georg Brandl
5fb481715c Remove outdated info and add an XXX. 2008-03-23 14:33:11 +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
cf7ebde5f8 Mention docutils version requirement. 2008-03-22 20:44:13 +00:00
Georg Brandl
6756c8be4d Fixes from Armin. 2008-03-22 13:14:00 +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
0fc710ed8c Add easy_install to sidebar. 2008-03-21 17:28:37 +00:00
Georg Brandl
3a111c3ebd Prepare for release. 2008-03-21 15:31:32 +00:00
Georg Brandl
5f78bc436b Use Windows-friendlier dirnames. 2008-03-21 15:20:50 +00:00
Georg Brandl
94a868db40 Fix directive parse_node function. 2008-03-21 14:29:39 +00:00
Georg Brandl
5f3df9ecd7 Add a note about sys.path in conf.py. 2008-03-21 14:26:21 +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
4d30e0bd40 Make it possible to deactivate the module index. 2008-03-18 19:54:45 +00:00
Georg Brandl
931cd9190a Add doc Makefile. 2008-03-18 19:52:26 +00:00
Georg Brandl
ae09a7f73b Move macro containing blocks to correct file. 2008-03-18 19:44:50 +00:00
Georg Brandl
39e8da70b9 Fill in some XXXs. 2008-03-18 18:19:21 +00:00
Georg Brandl
9f01c4c80a Add a para about sphinx <-> epydoc. 2008-03-18 07:39:40 +00:00
Georg Brandl
ae7273b9ae * Define __file__ during conf.py execution. 
* Make staticpath relative to conf.py dir.
 2008-03-16 20:52:34 +00:00
Georg Brandl
b1fbe7a2b6 Make the sphinxdoc layout work with IE. 2008-03-16 12:00:01 +00:00
Georg Brandl
f552676f9f Fix internal link. 2008-03-16 11:22:40 +00:00
Georg Brandl
ca528099f6 Update documentation, add more content. 2008-03-16 11:19:26 +00:00
Georg Brandl
06dd99e1a1 Expand the markup chapter a bit. 2008-03-15 09:06:04 +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
Georg Brandl
ccfd92e558 First pass at Sphinx documentation. Most of it still needs to be written :) 2008-03-09 21:32:24 +00:00