Commit Graph

918 Commits

Author SHA1 Message Date
Georg Brandl
f13c3a00cd Close #23: Added a `classmethod directive along with method`
and ``staticmethod``.
2008-12-29 00:11:06 +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
dc960ca7df Update translation catalogs. 2008-12-28 23:41:29 +01:00
Georg Brandl
ce52e9072e Some fixes and changelog entry after switch to Jinja2. 2008-12-28 23:39:26 +01:00
Georg Brandl
3e988f4917 merge in http://www.bitbucket.org/lunar/sphinx-jinja2/ 2008-12-28 23:23:18 +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
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
e2c52d6e90 Fix #77: If a description environment with info field list only
contains one ``:param:`` entry, no bullet list is generated.
2008-12-28 20:02:55 +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
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
Sebastian Wiesner
ff21914046 Merge with http://bitbucket.org/birkenfeld/sphinx 2008-12-23 20:25:15 +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
Sebastian Wiesner
00bfba6c54 Fix name error in template 2008-12-17 21:59:21 +01:00
Sebastian Wiesner
ae5a57d467 Automated merge with http://www.bitbucket.org/birkenfeld/sphinx/ 2008-12-16 19:28:41 +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