Commit Graph

33 Commits

Author SHA1 Message Date
Georg Brandl
c3eb669f8a Added the any role that can be used to find a cross-reference of
*any* type in *any* domain.  Custom domains should implement the new
`~Domain.resolve_any_xref` method to make this work properly.
2014-09-19 12:59:18 +02:00
EricFromCanada
36313d98b1 corrected contractions 2014-06-18 12:52:32 -04:00
EricFromCanada
65e924a3e4 rewrapping paragraphs when over 80 characters wide 2014-06-18 11:53:25 -04:00
Georg Brandl
763789463d merge with 1.0 2011-01-06 20:59:33 +01:00
Georg Brandl
8a3598ff8e Cross-reference to role docs. 2011-01-06 20:44:55 +01:00
Georg Brandl
40e692e6c3 #504: Add an `index` role, to make inline index entries. 2010-08-25 11:33:30 +00:00
Georg Brandl
ab334a2a6f Fix sectioning. 2010-08-23 15:58:26 +00:00
Georg Brandl
92142bbdb6 Allow references to PEPs and RFCs with explicit anchors. 2010-08-05 15:42:15 +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
0f7072f028 Allow linking to tables just like figures with :ref:. 2010-05-30 12:11:52 +02:00
Georg Brandl
9d3e02d238 Add an example. 2010-05-24 13:05:43 +02:00
Georg Brandl
0238e83013 Merge with http://bitbucket.org/tpowers/sphinx/ (rewriting the external/internal distinction code)
In HTML output, references now get the class ``internal`` if they are internal to the whole project, as opposed to internal to the current page.

The ``menuselection`` and ``guilabel`` roles now support ampersand accelerators.
2010-05-24 12:57:07 +02:00
Georg Brandl
f4f3066581 Use the new rst domain in the sphinx docs. 2010-04-17 10:39:51 +02:00
Georg Brandl
c219938a73 Write a bit more of the tutorial. 2010-03-09 19:32:59 +01:00
Georg Brandl
4f2523d17f Mention standard rst roles in inline markup. 2010-03-01 15:01:46 +01:00
Georg Brandl
a479d56b24 Move inline markup description to domains page. 2010-03-01 14:53:30 +01:00
Georg Brandl
61a55f095b Remove misguided recommendation to use emphasis for variables. 2009-06-15 17:43:32 +02:00
Georg Brandl
51265dfe3f #114: Added an `abbr` role to markup abbreviations and acronyms. 2009-03-05 09:48:55 +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
d271cc57b2 merge 2008-12-28 21:32:12 +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
f07d0afef2 Note how to change default role. 2008-12-28 21:29:40 +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
c49d8217e9 Fix #70: clarify meaning of |today|. 2008-12-15 10:26:07 +01:00
Georg Brandl
3206a6ab6f Add a note about substitutions. 2008-10-25 16:00:53 +00:00
Georg Brandl
47ce40c492 #16: allow referring to figures without explicit text. 2008-09-24 15:36:34 +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
7d4ce97ec3 Add default_role configuration value. 2008-06-17 10:06:37 +00:00
Georg Brandl
c5a4ebe008 :func: et al. should not include parens. 2008-04-19 17:00:31 +00:00
Georg Brandl
39e8da70b9 Fill in some XXXs. 2008-03-18 18:19:21 +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