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
1,531 Commits 2 Branches 219 Tags 163 MiB
1c030b415e
Commit Graph

176 Commits

Author SHA1 Message Date
Georg Brandl
55fde211f7 merge with 0.5 2009-02-17 18:34:22 +01:00
Georg Brandl
38e766c231 Allow "self" in toctrees, as a reference to the document containing the directive. 2009-02-17 18:17:17 +01:00
Georg Brandl
016f375403 merge with trunk 2009-02-15 10:46:17 +01:00
Georg Brandl
56b204b8a4 Use well-named IDs before auto-named IDs. 2009-02-15 02:49:08 +01:00
Georg Brandl
1219e3e73a merge with main 2009-02-14 23:25:30 +01:00
Georg Brandl
66609e8165 merge with 0.5 2009-02-14 20:19:16 +01:00
Georg Brandl
06b32a712f Image paths can now be absolute (like `/images/foo.png`). 
They are treated as relative to the top source directory.
 2009-02-14 15:29:18 +01:00
Georg Brandl
c09bf1ad85 merge with 0.5 2009-02-12 12:53:48 +01:00
Georg Brandl
26ae3f01aa Add a rst_epilog setting, usable for global substitutions. 2009-02-07 19:41:10 +01:00
Georg Brandl
394282223b Patch from Stefan Seefeld: make local toctree collapsible. 2009-02-07 13:32:47 +01:00
Georg Brandl
1e347aba51 Skip pygments-related tests if it is not installed. 2009-02-06 22:18:16 +01:00
Georg Brandl
4e3c3a43fc The new `trim_footnote_reference_space` config value mirrors 
the docutils config value of the same name and removes the
space before a footnote reference that is necessary for reST
to recognize the reference.
 2009-01-26 23:38:02 +01:00
Georg Brandl
d1e6119461 merge with trunk 2009-01-26 22:44:38 +01:00
Georg Brandl
f1e39097c6 Add a minimal test for external toctree links and fix a small bug found by it. 2009-01-26 22:04:29 +01:00
Georg Brandl
e974741c74 Added a toctree variable to the templates, and the ability to 
include external links in toctrees.

Patch by Stefan Seefeld.
 2009-01-26 21:57:15 +01:00
Georg Brandl
55c4f5a096 merge with trunk 2009-01-22 19:25:24 +01:00
Georg Brandl
a8756fb4b3 merge with 0.5 2009-01-14 19:39:42 +01:00
Georg Brandl
1f987f6af6 merge with trunk 2009-01-14 00:00:27 +01:00
Georg Brandl
88639dc45e merge with 0.5 2009-01-13 23:59:01 +01:00
Georg Brandl
b068e91803 Reformat to EOL80. 2009-01-10 21:23:39 +01:00
Benjamin Peterson
9a4369a413 remove usage of .message 2009-01-10 12:46:01 -06:00
Georg Brandl
5df8e162f9 Fix a few remaining copyrights and add 2009 to license. 2009-01-04 14:39:36 +01:00
Georg Brandl
f16f94f2cd Merge in copyright style changes from 0.5. 2009-01-03 12:15:19 +01:00
Georg Brandl
6a8b0aa599 merge in 0.5 2009-01-03 11:33:44 +01:00
Georg Brandl
29e893205e merge in 0.5 2009-01-02 14:53:33 +01:00
Georg Brandl
1aa8baa0d8 Fix #46: allow linking to special labels via :ref:abc <genindex>. 2008-12-28 23:59:40 +01:00
Georg Brandl
5d05ffc883 Fix #6: Don't generate redundant `<ul>` for top-level TOC tree 
items, which leads to a visual separation of TOC entries.
 2008-12-28 21:56:22 +01:00
Georg Brandl
b3d55c3139 Close #4: Added a `:download:` role that marks a non-document file 
for inclusion into the HTML output and links to it.
 2008-12-28 21:30:25 +01:00
Georg Brandl
78dec65bcc Due to popular demand, added a `:doc:` role which directly 
links to another document without the need of creating a
label to which a ``:ref:`` could link to.
 2008-12-28 19:44:54 +01:00
Georg Brandl
26d7aafaae Explicitly refer to the license in :license: tags. 2008-12-27 12:19:17 +01:00
Georg Brandl
c74163d0a0 The `toctree directive now supports a :hidden:` flag, 
which will prevent links from being generated in place of
the directive -- this allows you to define your document
structure, but place the links yourself.
 2008-12-20 23:23:39 +01:00
Georg Brandl
5b10659f87 Fix for Unicode strftime formats. 2008-11-13 09:35:01 +01:00
Georg Brandl
f490645392 #31: apply title transformations for xref roles in TOCs too. 2008-11-09 20:48:32 +01:00
Georg Brandl
4c3f2f0d7e Add classes to toctree items that indicate depth. 2008-11-09 20:43:36 +01:00
Georg Brandl
fb26a2a5fc #14: allow distinct programs for cmdoption directive. 2008-11-09 18:28:36 +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
ef3528b36e #4251: some module links didn't have proper anchors. 2008-11-08 13:55:17 +01:00
Georg Brandl
dbfe74d5e6 Fix the handling of images in different directories. 2008-11-06 10:36:56 +01:00
Georg Brandl
3715bd90a0 Don't disable alphabetical and roman lists anymore. 2008-10-25 16:53:29 +00:00
Georg Brandl
406aae4d6a Fix outdated docstring. 2008-10-25 16:09:15 +00:00
Georg Brandl
29a3a86cef Add global citations. #1. 2008-10-25 15:54:34 +00:00
Georg Brandl
4b9119f990 Support <meta> tags via meta directive. 2008-10-18 09:29:49 +00:00
Georg Brandl
516d1a2872 Add "source_encoding" config value. 2008-10-16 19:21:06 +00:00
Georg Brandl
d7e2a48555 Add "source-read" event. 2008-10-16 19:04:45 +00:00
Georg Brandl
869df5123b Add cmember role (#3875). 2008-09-24 17:09:48 +00:00
Georg Brandl
47ce40c492 #16: allow referring to figures without explicit text. 2008-09-24 15:36:34 +00:00
Georg Brandl
246a7a09b6 Add _() to some english strings. 2008-09-11 22:08:29 +00:00
Georg Brandl
94bd56e4e4 Some pylint-found fixes and cleanups. 2008-09-06 17:34:35 +00:00
Georg Brandl
e6a6087335 Use alternate method of removing node from doctree which 
doesn't raise assertion errors. :)
 2008-08-15 19:16:20 +00:00
Georg Brandl
742821d6e0 Simplify index entry handling. 2008-08-11 08:40:12 +00:00
Georg Brandl
74d52b40bc Add exclude_dirnames value. 2008-08-10 17:21:08 +00:00
Georg Brandl
b3f1de1bf7 New config value "keep_warnings", default is to discard the from the saved doctrees. 2008-08-10 17:10:31 +00:00
Georg Brandl
e93af0e57c Merged revisions 65566-65567,65623,65625 via svnmerge from 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r65566 | georg.brandl | 2008-08-07 09:11:11 +0000 (Thu, 07 Aug 2008) | 2 lines

  Clarification for the ref role.
........
  r65567 | georg.brandl | 2008-08-07 09:11:25 +0000 (Thu, 07 Aug 2008) | 2 lines

  Rebuild everything if extensions change.
........
  r65623 | georg.brandl | 2008-08-10 11:18:42 +0000 (Sun, 10 Aug 2008) | 2 lines

  Unify handling of LaTeX escaping, and add some more replacements.
........
  r65625 | georg.brandl | 2008-08-10 11:25:41 +0000 (Sun, 10 Aug 2008) | 2 lines

  Make tex escapes a module.
........
 2008-08-10 16:59:27 +00:00
Georg Brandl
74d36acbf7 * Add more generated text to the automatic translation. 
* Remove all locale-dependent text from sphinx.sty, put it into Python files
  to enable message extraction and translation.
* Use babel in the LaTeX output.
* Centralize locations for labels used in every builder.
 2008-08-10 10:00:20 +00:00
Georg Brandl
a7cfb52ab6 Add i18n support, thanks to Horst Gutmann. 2008-08-08 10:54:00 +00:00
Georg Brandl
432115123e Merged revisions 65529 via svnmerge from 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r65529 | georg.brandl | 2008-08-04 22:19:30 +0000 (Mon, 04 Aug 2008) | 6 lines

  Revert r65499 which was not well thought out. Instead, put
  the whole build dir in exclude_trees by default in quickstart.

  Also, revisit application cleanup and make it consistently use
  less setup time while still trying to leave to traces.
........
 2008-08-04 22:20:44 +00:00
Georg Brandl
b4f71aa642 Merged revisions 65283,65303,65316-65317,65372-65375,65377,65380,65483-65485,65494 via svnmerge from 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r65283 | georg.brandl | 2008-07-29 10:07:26 +0000 (Tue, 29 Jul 2008) | 2 lines

  Update ez_setup.py.
........
  r65303 | benjamin.peterson | 2008-07-30 12:35:34 +0000 (Wed, 30 Jul 2008) | 1 line

  add a with_testapp decorator for test functions that passes the TestApp instance in a cleans up after it
........
  r65316 | benjamin.peterson | 2008-07-30 23:12:07 +0000 (Wed, 30 Jul 2008) | 1 line

  make the app for test_markup global to the module
........
  r65317 | benjamin.peterson | 2008-07-30 23:31:29 +0000 (Wed, 30 Jul 2008) | 1 line

  make TestApp.cleanup more aggressive
........
  r65372 | georg.brandl | 2008-08-01 19:11:22 +0000 (Fri, 01 Aug 2008) | 2 lines

  Add more tests, fix a few bugs in image handling.
........
  r65373 | georg.brandl | 2008-08-01 19:28:33 +0000 (Fri, 01 Aug 2008) | 2 lines

  Fix oversight.
........
  r65374 | benjamin.peterson | 2008-08-01 19:36:32 +0000 (Fri, 01 Aug 2008) | 1 line

  fix one broken test
........
  r65375 | georg.brandl | 2008-08-01 19:41:11 +0000 (Fri, 01 Aug 2008) | 2 lines

  Fix the handling of non-ASCII input in quickstart.
........
  r65377 | georg.brandl | 2008-08-01 19:48:24 +0000 (Fri, 01 Aug 2008) | 2 lines

  Allow REs in markup checks.
........
  r65380 | georg.brandl | 2008-08-01 20:31:18 +0000 (Fri, 01 Aug 2008) | 2 lines

  Don't rely on mtimes being different for changed files.
........
  r65483 | georg.brandl | 2008-08-04 09:01:40 +0000 (Mon, 04 Aug 2008) | 4 lines

  Add an "encoding" option to literalinclude.

  Add tests for include directives.
........
  r65484 | georg.brandl | 2008-08-04 09:11:17 +0000 (Mon, 04 Aug 2008) | 2 lines

  Add changelog entry.
........
  r65485 | georg.brandl | 2008-08-04 09:21:58 +0000 (Mon, 04 Aug 2008) | 2 lines

  Fix markup.
........
  r65494 | georg.brandl | 2008-08-04 16:34:59 +0000 (Mon, 04 Aug 2008) | 2 lines

  Correctly use HTML file suffix in templates.
........
 2008-08-04 17:01:15 +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
6c2f991be0 Merged revisions 65138,65145-65146,65268-65273 via svnmerge from 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r65138 | georg.brandl | 2008-07-19 15:42:35 +0200 (Sat, 19 Jul 2008) | 2 lines

  #3416: fix missing parameter.
........
  r65145 | georg.brandl | 2008-07-19 20:01:25 +0200 (Sat, 19 Jul 2008) | 2 lines

  Now that we don't ship Jinja anymore by default the comment can go.
........
  r65146 | georg.brandl | 2008-07-19 20:01:51 +0200 (Sat, 19 Jul 2008) | 2 lines

  Reread documents with globbed toctrees when files are removed/added.
........
  r65268 | georg.brandl | 2008-07-29 10:21:33 +0200 (Tue, 29 Jul 2008) | 2 lines

  Fix by Markus Gritsch to place correct links to headings.
........
  r65269 | georg.brandl | 2008-07-29 10:21:59 +0200 (Tue, 29 Jul 2008) | 2 lines

  Make the writer's settings public.
........
  r65270 | georg.brandl | 2008-07-29 10:22:28 +0200 (Tue, 29 Jul 2008) | 2 lines

  Export test_root.
........
  r65271 | georg.brandl | 2008-07-29 10:22:47 +0200 (Tue, 29 Jul 2008) | 2 lines

  Add a markup test.
........
  r65272 | georg.brandl | 2008-07-29 10:27:19 +0200 (Tue, 29 Jul 2008) | 2 lines

  Bump version number.
........
  r65273 | georg.brandl | 2008-07-29 11:05:37 +0200 (Tue, 29 Jul 2008) | 2 lines

  Correct rendering of ``samp``.
........
 2008-07-29 09:07:37 +00:00
Georg Brandl
ae2570c269 Merged revisions 64808,65013,65076,65100-65101,65119,65121-65123 via svnmerge from 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r64808 | georg.brandl | 2008-07-08 21:39:33 +0200 (Tue, 08 Jul 2008) | 2 lines

  Allow relocation of source and doctree dir.
........
  r65013 | georg.brandl | 2008-07-16 15:25:30 +0200 (Wed, 16 Jul 2008) | 2 lines

  Remove curious quote.
........
  r65076 | georg.brandl | 2008-07-17 22:43:01 +0200 (Thu, 17 Jul 2008) | 2 lines

  Add a test for sphinx.quickstart.
........
  r65100 | georg.brandl | 2008-07-18 14:41:54 +0200 (Fri, 18 Jul 2008) | 2 lines

  Fix phony targets.
........
  r65101 | georg.brandl | 2008-07-18 14:55:03 +0200 (Fri, 18 Jul 2008) | 2 lines

  Fix problems in "make check".
........
  r65119 | georg.brandl | 2008-07-18 23:06:42 +0200 (Fri, 18 Jul 2008) | 2 lines

  Emit a more precise error message in autodoc.
........
  r65121 | georg.brandl | 2008-07-18 23:41:35 +0200 (Fri, 18 Jul 2008) | 2 lines

  Warn if a toctree-included document doesn't contain a title.
........
  r65122 | georg.brandl | 2008-07-18 23:51:28 +0200 (Fri, 18 Jul 2008) | 2 lines

  Don't use \samp{} for code with whitespaces, only for :samp:`code`.
........
  r65123 | georg.brandl | 2008-07-19 00:49:46 +0200 (Sat, 19 Jul 2008) | 2 lines

  Put inheritance info always on its own line.
........
 2008-07-18 22:55:36 +00:00
Georg Brandl
17e7e61778 Merged revisions 64703-64708,64710-64712 via svnmerge from 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r64703 | georg.brandl | 2008-07-04 19:24:00 +0200 (Fri, 04 Jul 2008) | 2 lines

  Fix linkcheck builder crash for malformed URLs.
........
  r64704 | georg.brandl | 2008-07-04 19:32:40 +0200 (Fri, 04 Jul 2008) | 2 lines

  Add 0.5 compatibility for more admonitions.
........
  r64705 | georg.brandl | 2008-07-04 19:38:37 +0200 (Fri, 04 Jul 2008) | 2 lines

  Remove silly "rubric" restriction in latex writer.
........
  r64706 | georg.brandl | 2008-07-04 19:41:44 +0200 (Fri, 04 Jul 2008) | 2 lines

  Document rubric:: Footnotes behavior.
........
  r64707 | georg.brandl | 2008-07-04 19:45:28 +0200 (Fri, 04 Jul 2008) | 2 lines

  Fix XHTML.
........
  r64708 | georg.brandl | 2008-07-04 19:50:56 +0200 (Fri, 04 Jul 2008) | 2 lines

  More XHTML fixes.
........
  r64710 | georg.brandl | 2008-07-04 19:59:56 +0200 (Fri, 04 Jul 2008) | 2 lines

  Copy the html_logo to the output static dir.
........
  r64711 | georg.brandl | 2008-07-04 20:37:43 +0200 (Fri, 04 Jul 2008) | 2 lines

  Fix latex code for module names with underscores that have platforms.
........
  r64712 | georg.brandl | 2008-07-04 20:46:40 +0200 (Fri, 04 Jul 2008) | 2 lines

  Fix a crash with nonlocal image URIs.
........
 2008-07-04 18:49:39 +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
326ca06e1b Fix image handling. 2008-06-18 10:06:22 +00:00
Georg Brandl
b2eb896d7e Increment env version after the image handling change. 2008-06-17 10:22:04 +00:00
Georg Brandl
7d4ce97ec3 Add default_role configuration value. 2008-06-17 10:06:37 +00:00
Georg Brandl
b05861454c Add image format handling. 2008-06-15 14:31:16 +00:00
Georg Brandl
d67511466d #3096: sort "unused" warnings by docname. 2008-06-12 21:57:31 +00:00
Georg Brandl
bd4166c2d6 Add maxdepth for TOCs. 2008-06-12 21:56:06 +00:00
Georg Brandl
e8bb912a9c Factor out toctree resolution and add an option to ignore 
sublevel document headings.
 2008-06-12 21:48:27 +00:00
Armin Ronacher
70a54d2264 env is set now to nodes after unpickling. 2008-06-08 18:17:20 +00:00
Georg Brandl
f4d5c0a380 Add a test suite skeleton, a first test for sphinx.config, and fix a bug in config. 2008-06-05 08:58:43 +00:00
Georg Brandl
7e80f60412 Fix the handling of extensions' config values. 2008-06-04 20:25:27 +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
869552d616 Refer to a RFC base URL that actually works. 2008-05-31 22:54:10 +00:00
Georg Brandl
c7110a4199 More logical "next"/"previous" links. 2008-05-31 22:52:42 +00:00
Georg Brandl
5eaf2eb29a Add exclude_trees config value. 2008-05-24 16:28:06 +00:00
Georg Brandl
407a0c47c1 Some pylint nits. 2008-05-04 16:17:31 +00:00
Georg Brandl
7ad49d5756 Add exclude_dirs config value. 2008-05-02 09:15:59 +00:00
Georg Brandl
ea5f9d7de7 Allow any master document structure when writing the HTML help contents file. 2008-05-02 09:00:09 +00:00
Georg Brandl
b2aedf951d Ignore classes in conf.py. 2008-04-22 17:41:12 +00:00
Georg Brandl
be080234bb Support Sphinx.add_transform(). 2008-04-13 08:20:11 +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
9fb011bd2a Fix the case where a toctree doesn't contain anything. 2008-04-06 13:32:15 +00:00
Georg Brandl
b8369b5c81 Allow new titles in the toctree. 2008-03-30 06:36:20 +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
6433cca6a8 Record deps from autodoc. 2008-03-25 10:31:13 +00:00
Georg Brandl
55aacf998a Handle errors more gracefully. 2008-03-25 10:20:09 +00:00
Georg Brandl
10e231bf12 Add a dependency system for handling .. include, .. literalinclude 
and later .. image dependencies.
 2008-03-25 10:16:51 +00:00
Georg Brandl
93d39ac065 Don't error out on reading an empty file. 2008-03-24 09:42:28 +00:00
Georg Brandl
0de9d7db7a Don't try to build copied sources if source suffix is .txt. 2008-03-23 18:26:24 +00:00
Georg Brandl
fb3fa0708b Bump ENV_VERSION after introduction of CodeBlocksHandler. 2008-03-23 06:36:08 +00:00
Georg Brandl
e77d39cb0b Remove leftover code that does not work. 2008-03-23 06:33:04 +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
637b1379bc Fix a few overlong lines, and use \t instead of literal tabs. 2008-03-21 15:27:21 +00:00
Georg Brandl
5d253d4293 Don't warn for unknown keywords. Give Python refs a link title. 2008-03-16 11:10:03 +00:00
Georg Brandl
910e488e39 * Allow registering arbitrary cross-referencing directives/roles. 
* Allow labels anywhere, and allow giving an explicit caption in :ref: links.
* Some fixes to the sphinxdoc style.
* Add an option to show author information in the output.
* Search user-defined templates in the order they occur in the config
  (thanks Nick).
 2008-03-09 18:18:41 +00:00
Georg Brandl
a95a40c748 Add some labels by default; create a master doc in quickstart. 2008-03-08 21:23:54 +00:00
Georg Brandl
8dc8280c3c Ignore nonexisting config settings. 2008-02-10 10:59:05 +00:00