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
3,238 Commits 2 Branches 219 Tags 163 MiB
c9e18c2646
Commit Graph

326 Commits

Author SHA1 Message Date
Georg Brandl
4e60f4e7cb Make lookup_domain_element a method of the env. 2010-01-17 19:45:11 +01:00
Georg Brandl
98bcd2fab4 Make the _ gettext alias an explicit import instead of installing into builtins. 2010-01-17 19:33:23 +01:00
Georg Brandl
bacb6435e4 merge with trunk 2010-01-17 17:52:51 +01:00
Georg Brandl
1ec19290e1 Rename os to osutil, thanks to relative imports. 2010-01-17 17:49:01 +01:00
Georg Brandl
b0e2c44dc8 merge with trunk 2010-01-17 17:43:33 +01:00
Georg Brandl
c5d67b0321 Refactor util package. 2010-01-17 17:35:12 +01:00
Georg Brandl
5d40d8bd63 merge with trunk 2010-01-17 14:24:24 +01:00
Georg Brandl
d292cea80d Allow missing-reference event for :ref: too. 2010-01-17 11:58:39 +01:00
Georg Brandl
54a31c5a6f Change naming convention in doc_read_data to "domain:key". 2010-01-13 20:45:34 +01:00
Georg Brandl
c49c9b288b Make refdoc node attribute optional. 2010-01-12 09:18:35 +00:00
Georg Brandl
c37ddd0a6f Add some XXXes... sigh. 2010-01-08 18:54:41 +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
5cb64a7228 Apply static path exclusion patterns again. 
Refactor exclusion stuff a bit, so that matchers only have to be compiled once.
 2010-01-07 16:39:59 +01:00
Georg Brandl
a4ca76db7e Fix long line. 2010-01-07 14:35:24 +01:00
Georg Brandl
ab7ac64e1a Add new universal config value `exclude_patterns`, with glob-style exclude patterns. 
This makes the old ``unused_docs``, ``exclude_trees`` and ``exclude_dirnames`` obsolete.
 2010-01-06 15:48:39 +01:00
Georg Brandl
c3c3f739af Remove the deprecated `exclude_dirs` config value. 2010-01-06 15:54:34 +01:00
Georg Brandl
fc3113d847 Fix long line. 2010-01-03 22:22:33 +01:00
Georg Brandl
7bafd3d553 merge with 0.6 2010-01-03 16:04:23 +01:00
Georg Brandl
9d15d3f654 #302: Fix links generated by the `:doc:` role for LaTeX output. 
For that, record the source docname in an xfileref node in node['refdoc'].
The LaTeX builder creates one big toctree out of all documents, therefore
"fromdocname" in resolve_references refers to the wrong file.
 2010-01-03 16:03:08 +01:00
Georg Brandl
7e53338d9a merge with 0.6 2010-01-03 11:55:57 +01:00
Georg Brandl
0b70a32efe Ignore images in section titles when generating link captions. 
(Otherwise, the "alt" text leaks into the caption, and docutils automatically
assigns an alt text to images in substitutions.)
 2010-01-03 11:42:15 +01:00
Georg Brandl
faeec5cbbb merge with trunk 2010-01-02 21:03:56 +01:00
Georg Brandl
32437e45bd merge with 0.6 2010-01-02 00:49:51 +01:00
Georg Brandl
2af4986e78 IE apparently does not like href=""; change this to href="#" which appears to work. 2010-01-02 00:30:42 +01:00
Georg Brandl
47ccbccc62 merge with 0.6 2010-01-01 14:10:48 +01:00
Georg Brandl
f6a56192d1 Happy new year! 2010-01-01 14:09:13 +01:00
Georg Brandl
18230a6060 merge with trunk 2009-12-23 12:13:40 +01:00
Georg Brandl
9e7c5e88c4 Fix some nits after pulling from http://bitbucket.org/howthebodyworks/sphinx/ and add changelog and authors entries. 2009-12-23 11:53:19 +01:00
Dan MacKinlay
d532fc2d9f sphinx now preserves lots of useful document metadata 2009-12-22 16:49:40 +11:00
Georg Brandl
d12ad380f2 Finish renaming description units to object (description)s. 2009-10-27 19:58:40 +01:00
Georg Brandl
30f8dbdbf8 Cosmetic changes. 2009-09-12 10:19:13 +00:00
Georg Brandl
2bbb29385e Remove env.note_versionchange(). 2009-09-12 10:17:02 +00:00
Georg Brandl
68c545cf22 Refactor directive/role lookup from domains a bit to avoid code duplication. 2009-09-12 10:14:27 +00:00
Georg Brandl
732e2b377f Move :envvar: index markup logic over to std domain. 2009-09-09 19:35:50 +02:00
Georg Brandl
0792ad7498 The `toctree() callable in templates now has a maxdepth` 
keyword argument to control the depth of the generated tree.

Also add tests for that callable.
 2009-09-09 15:56:52 +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
Georg Brandl
0d029eeb9c merge with trunk 2009-09-04 00:17:41 +02:00
Georg Brandl
894cac3390 merge with 0.6 2009-09-04 00:16:34 +02:00
Georg Brandl
dcff10ddaa Cleanup unused imports. 2009-09-04 00:05:09 +02:00
Georg Brandl
0e37970007 raise ExtensionError for unregistered domains 2009-09-02 17:31:49 +00:00
Georg Brandl
f64d01bea2 Fix resolution of references without domain. 2009-08-09 22:05:03 +02:00
Georg Brandl
94f0c051c5 Fix remaining uses of xfileref_role. 2009-08-09 20:27:36 +02:00
Georg Brandl
3352493642 merge pre-domain state with tip from 0.6 2009-08-06 21:36:57 +02:00
Georg Brandl
86686262bd merge with 0.6 2009-08-05 00:04:39 +02:00
Georg Brandl
b423f9f280 Fix generation of the index when there are symbols with ASCII value larger than that of the lowercase letters. 2009-07-25 14:58:58 +02:00
Georg Brandl
015a633863 Do link to self. 2009-10-26 18:54:16 +01:00
Georg Brandl
960ba9ec41 merge with 0.6 2009-06-16 22:19:59 +02:00
Georg Brandl
8003801e8d #189: dont use title set by title directive for links, only for HTML title. 2009-06-16 22:02:51 +02:00
Georg Brandl
a6fdc4602a merge with 0.6 2009-06-16 21:32:05 +02:00
Georg Brandl
28b1f7eef6 Remove debugging code. 2009-06-16 19:59:16 +02:00
Georg Brandl
8820e99440 Added `titlesonly option to toctree` directive. 2009-06-15 18:05:07 +02:00
Georg Brandl
72516863b6 Add API to add components to a domain. 2009-07-28 17:45:02 +00:00
Georg Brandl
1c030b415e With a few disabled features (see XXX), the test suite runs again. 2009-07-13 21:28:01 +02:00
Georg Brandl
a1dd4695f3 First step of domain handling in environment. 2009-07-13 20:53:11 +02:00
Georg Brandl
db8395f9e1 Add make_refnode() utility function. 2009-07-13 18:27:34 +02:00
Georg Brandl
c92f97d848 Move xref resolution to domain class. 2009-07-13 17:28:07 +02:00
Georg Brandl
ab7cfb4a99 Make domains instances, which have factory methods for their roles and directives. 2009-07-13 16:59:45 +02:00
Georg Brandl
c02b7149aa Move domain-specific code around a bit; builtin domains are now completely in sphinx.domains. Test suite does not pass yet. 2009-07-05 12:24:27 +02:00
Georg Brandl
43667a2a9c Remove filemodules attribute which isnt used anymore. 2009-06-29 18:43:59 +02:00
Georg Brandl
5c6697e69f Fix some oversights. 2009-06-29 17:16:05 +02:00
Georg Brandl
2ea1de50a9 Introduce "domains". 2009-06-29 17:04:33 +02:00
Georg Brandl
92eef1b2e5 Set the default encoding to `utf-8-sig` to handle files with a 
UTF-8 BOM correctly.
 2009-05-31 18:58:28 +02:00
Georg Brandl
b4365ad72b #173: Respect the docutils `title` directive. 2009-05-17 19:15:28 +02:00
Georg Brandl
61146192c7 #172: The `obj` role now links to modules as promised. 2009-05-17 12:58:48 +02:00
Georg Brandl
adfb8c2668 Fix speling. 2009-05-16 12:47:18 +02:00
Georg Brandl
82af37ea7c Don't put image "alt" text into table-of-contents entries. 2009-04-28 20:46:24 +02:00
Georg Brandl
b966975ca6 Fix a small problem with rfind() methods. 2009-04-10 11:10:38 +02:00
Georg Brandl
30fe6d4190 Sanitize the Environment.update() method API. 2009-03-05 20:25:39 +01:00
Georg Brandl
b244dbf9b5 Use standard `file:line: warning: message` format for warning messages. 2009-03-05 09:21:35 +01:00
Georg Brandl
d31f68be58 Make "numbered" toctree attribute optional. 2009-02-24 21:05:50 +01:00
Georg Brandl
9ed275c868 #109: fix circular import problems by moving exceptions into their own module. 2009-02-24 19:15:39 +01:00
Georg Brandl
fb511a015a Paths to literal include files and download files can now be absolute too. 2009-02-24 13:38:15 +01:00
Georg Brandl
5f0a7375c8 Bump ENV_VERSION after section numbering change. 2009-02-22 16:30:40 +01:00
Georg Brandl
7792e27030 #10: implement HTML section numbering. 2009-02-22 15:22:23 +01:00
Georg Brandl
18c3748c98 merge with 0.5 2009-02-21 19:59:33 +01:00
Georg Brandl
2d0345a7d9 #71: If a decoding error occurs in source files, print a warning and replace the characters by "?". 2009-02-21 19:58:52 +01:00
Georg Brandl
b861ee622a Only move module targets that really come from module directives. 2009-02-20 09:43:00 +01:00
Georg Brandl
a43b651804 Make "make check" happy. 2009-02-19 23:31:34 +01:00
Georg Brandl
4c81b055c8 Added an `only` directive that can selectively include text 
based on enabled "tags".  Tags can be given on the command
line.  Also, the current builder output format (e.g. "html" or
"latex") is always a defined tag.
 2009-02-19 21:56: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
0a703edf40 merge with 0.5 2009-02-18 10:10:06 +01:00
Georg Brandl
2244e57222 Backport two fixes that should have been made here. 2009-02-18 10:09:17 +01:00
Georg Brandl
342ef89bda Fix the fix for #82. 2009-02-18 01:13:57 +01:00
Georg Brandl
071756377a Don't output system messages while resolving, because they would stay in the doctrees even if keep_warnings is false. 2009-02-17 18:57:51 +01:00
Georg Brandl
3984c0f05c #82: Determine the correct path for dependencies noted by 
docutils.  This fixes behavior where a source with dependent
files was always reported as changed.
 2009-02-17 18:33:48 +01:00
Georg Brandl
33bed1ef6b Recognize toctree directives that are not on section toplevel, 
but within block items, such as tables.
 2009-02-14 20:19:01 +01:00
Georg Brandl
1b283a49c5 Use better error messages for unsupported markup in LaTeX documents. 2009-02-12 12:46:25 +01:00
Georg Brandl
5250c2efa9 Use a new RFC base URL, since rfc.org seems down. 2009-02-12 12:15:26 +01:00
Georg Brandl
eefc54baca Fix #86; merged from mq 2009-01-14 19:39:27 +01:00
mq
fccd4fff66 fix custom link titles in toctrees 2009-01-14 14:44:10 +01:00
Georg Brandl
677d096393 On Windows, the target of os.rename() may not exist. 2009-01-13 23:55:24 +01:00
Georg Brandl
0b28b3e6f6 Switch copyright and license tags to single style. Add contributor 
names in AUTHORS instead, and add the license of etree13 to
LICENSE.
 2009-01-03 11:57:07 +01:00
Georg Brandl
9b48c13ee8 * #81: Write environment and search index in a manner that is safe 
from exceptions that occur during dumping.
 2009-01-03 11:13:43 +01:00
Georg Brandl
8af0caea30 Fix #80: use string.ascii_* constants in case locale.setlocale() is 
somehow called which then leads to UnicodeErrors.
 2009-01-02 14:51:55 +01:00
Georg Brandl
83dba8fc76 Fix #60: "smart" image inclusion in subdirs. 2008-12-08 08:44:18 +01:00
Georg Brandl
a967dc4027 Fix #60: Don't crash for invalid index entries. 2008-11-30 20:56:08 +01:00
Georg Brandl
03a9656c72 merge with 0.5 2009-02-17 18:59:47 +01:00
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