Commit Graph

898 Commits

Author SHA1 Message Date
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
a2363c0751 Fix test_autodoc after return annotation change. 2008-12-28 19:44:10 +01:00
Georg Brandl
377b461b1c Factor out docname path joining into an utility function. 2008-12-28 19:11:32 +01:00
Benjamin Peterson
7433721617 use stacklevel=2 for easier debugging 2008-12-27 14:14:10 -06:00
Georg Brandl
38fff57d72 Add MapServer. 2008-12-27 12:22:18 +01:00
Georg Brandl
26d7aafaae Explicitly refer to the license in :license: tags. 2008-12-27 12:19:17 +01:00
Georg Brandl
5975e6c0f6 Cosmetic changes. 2008-12-26 20:29:23 +01:00
Georg Brandl
83c9f7a849 Improve builder docs a bit. 2008-12-26 20:17:59 +01:00
Georg Brandl
5713270079 Don't require init() method in builders. 2008-12-26 20:09:17 +01:00
Georg Brandl
a5e1d06ccc Change the way to handle return annotations a bit. 2008-12-25 22:06:10 +01:00
Georg Brandl
0a1b821c7f Handle class aliases (like `class Foo: factory = dict`) better in autodoc. 2008-12-25 21:50:45 +01:00
Georg Brandl
b80d874126 Add text target. 2008-12-25 21:44:38 +01:00
Georg Brandl
a26aa3315f Add html_link_suffix value. 2008-12-25 17:59:32 +01:00
Georg Brandl
dafb55a467 Fix documentation of inner classes in autodoc. Messy! 2008-12-23 20:05:56 +01:00
Georg Brandl
409cc1fe39 Remove sphinx.builder usage. 2008-12-23 20:04:45 +01:00
Georg Brandl
f5ea8295cd Fix leftovers. 2008-12-21 00:24:36 +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
fc6a50903c Source links in HTML are now generated with `rel="nofollow"`. 2008-12-20 23:47:06 +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
f02a90ca6e Add sidebarsourcelink block. 2008-12-20 23:08:26 +01:00
Georg Brandl
350e5ff3c9 Automated merge with file:///home/gbr/devel/sphinx0.5 2008-12-20 23:05:27 +01:00
Georg Brandl
5f8e73d334 Add SQLAlchemy. 2008-12-17 22:51:07 +01:00
Georg Brandl
3531bf6afa Fix NameError if Pygments is not installed. 2008-12-16 07:30:00 +01:00
Georg Brandl
711a1fa7ed Merge in 0.5.1 release. 2008-12-15 22:08:46 +01:00
Georg Brandl
0ef0c50f03 Post-release updates. 2008-12-15 22:07:28 +01:00
Georg Brandl
894e5b2bcd Added tag 0.5.1 for changeset dfe5aae7c8ad 2008-12-15 22:06:20 +01:00
Georg Brandl
3f8d3b634f Prepare for 0.5.1 release. 2008-12-15 21:55:50 +01:00
Georg Brandl
f21769a232 Merge in #67 bugfix. 2008-12-15 20:00:58 +01:00
Georg Brandl
04f02b34d0 Fix #67: Output warnings about failed doctests in the doctest extension
even when running in quiet mode.
2008-12-15 19:59:23 +01:00
Georg Brandl
1d8f1f1520 Remove duplicate warning. 2008-12-15 19:52:59 +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
db09844726 Remove last web leftovers. 2008-12-15 14:06:05 +01:00
Georg Brandl
b44636b6a0 Add a DeprecationWarning for sphinx.builder. 2008-12-15 13:50:54 +01:00
Georg Brandl
f5cb011e77 The new `html_show_sourcelink` config value can be used to
switch off the links to the reST sources in the sidebar.
2008-12-15 13:38:39 +01:00
Georg Brandl
037954d850 The `autodoc_skip_member` event now also gets to decide
whether to skip members whose name starts with underscores.
Previously, these members were always automatically skipped.
Therefore, if you handle this event, add something like this
to your event handler to restore the old behavior::

   if name.startswith('_'):
       return True
2008-12-15 12:49:40 +01:00
Georg Brandl
69ff09917c Merge in 0.5 bugfixes. 2008-12-15 12:33:24 +01:00
Georg Brandl
5066f49fbe Add "doctest_global_setup" conf val. 2008-12-15 12:33:13 +01:00
Georg Brandl
9e9766a41a Fix two issues with non-ASCII characters being written to byte streams. 2008-12-15 11:35:27 +01:00
Georg Brandl
7debd67c23 Warn if doctest blocks don't contain code. 2008-12-15 11:29:07 +01:00
Georg Brandl
7c02f11ec1 Merge bugfixes from 0.5. 2008-12-15 11:12:08 +01:00
Georg Brandl
44b0929669 Fix handling of :param: and :type: with roles. 2008-12-15 11:11:47 +01:00
Georg Brandl
c49d8217e9 Fix #70: clarify meaning of |today|. 2008-12-15 10:26:07 +01:00
Georg Brandl
628adc4d03 Add Italian locale, translation by Sandro Dentella. 2008-12-15 10:21:01 +01:00
Georg Brandl
934463e30a Merge in two bugfixes. 2008-12-10 00:44:29 +01:00
Georg Brandl
b7a2491e21 #65: Store depth information in PNG images themselves. 2008-12-10 00:43:11 +01:00
Georg Brandl
0d88e4b020 Fix automethod outside class context. 2008-12-09 23:37:39 +01:00
Georg Brandl
1019fc933c Record move of writer/builder files. 2008-12-08 09:05:11 +01:00
Georg Brandl
be8f6609c6 Move again. 2008-12-08 08:59:51 +01:00