Commit Graph

120 Commits

Author SHA1 Message Date
Georg Brandl
269ef714f3 Closes #668: Allow line numbering of `code-block and literalinclude` directives
#to start at an arbitrary line number, with a new ``lineno-start`` option.
2014-01-11 08:44:45 +01:00
Georg Brandl
fcee847ae0 Merged in plaindocs/sphinx (pull request #185) 2014-01-10 09:24:23 +01:00
Eric Knibbe
3c8de18e86 corrected descriptions of tabularcolumns specifiers 2013-12-17 18:14:28 +00:00
Eric Knibbe
d952469a22 recommend exclude_patterns instead of unused_docs or exclude_trees 2013-12-17 18:12:54 +00:00
Samuel Wright
4784bb7e32 Removed duplicate comma. 2013-12-10 19:42:47 +01:00
Samuel Wright
4bcb7a2c1b Fixed wording. 2013-10-25 13:22:01 +02:00
Samuel Wright
b3286c6b82 Fix for Issue #1071 2013-10-25 13:08:03 +02:00
Roland Meister
88c72be190 Add warning for unusual chars in filenames. Closes #1199 2013-08-10 15:36:05 +02:00
Roland Meister
cc909ab2a9 More docs cleanup; add hint for the epub cover page 2013-06-07 20:48:14 +02:00
Roland Meister
ce6b8fff70 Clarify docs for the format and builder tags 2013-06-06 21:23:16 +02:00
Roland Meister
f879346cea Add the builder name as predefined tag for the only directive.
At the moment only the epub builder distinguishes between format and name.
Explicit entries with format_ and builder_ prefix are also added.
2013-04-25 23:08:30 +02:00
Roland Meister
1639f59726 Add includehidden option to the toctree directive
This option is equivalent to the includehidden option of the template function
toctree() and allows to restore to the toctree behaviour prior to version 1.1.
See also bug #790.
2013-01-06 14:55:35 +01:00
Jonathan Waltman
ead356e3cf Remove note about sectioning limitation of the "only" directive. 2012-09-12 16:40:10 -05:00
Georg Brandl
729565b7a9 Fixes #795: explain that titles on the same level as the document heading cannot be put into only directives. 2012-03-10 21:21:43 +01:00
Georg Brandl
2c77c05473 Merge with 1.0 2011-09-23 22:03:34 +02:00
Georg Brandl
ded4bee328 Add note about inclusion with the "include" directive. 2011-09-23 11:22:35 +02:00
Georg Brandl
ad5d9f7c6b Add changelog entry for emphasize-lines and some coding style fixes. 2011-09-22 09:29:36 +02:00
Mark Lodato
2c0f936e6b add :emphasize-lines: option to source-code and literal-include
Add a new option, :emphasize-lines:, to the source-code and
literal-include directives.  The format is the same as the :lines:
option for literal-include.  The resulting list of lines is passed to
the Pygments formatter as 'hl_lines', which is only honored by the HTML
formatter.
2011-07-06 22:58:19 -04:00
Georg Brandl
aa0c862d92 Fix typo. 2011-01-08 19:21:34 +01:00
Georg Brandl
8a3598ff8e Cross-reference to role docs. 2011-01-06 20:44:55 +01:00
Georg Brandl
a484a62f11 #578: doc clarification. 2011-01-04 00:08:38 +01:00
Georg Brandl
63db45dea9 Even more tweaking of the latex tabular environment selection code. 2011-01-03 23:34:57 +01:00
Georg Brandl
6964bdffb9 #565: In the LaTeX builder, not only literal blocks require different table handling, but also quite a few other list-like block elements. 2011-01-03 20:48:11 +01:00
Gary Wilson Jr.
175bc520e1 Fixed a couple links in the documentation for the contents docutils directive that were referring to the incorrect anchor. 2011-06-28 13:13:08 -05:00
Georg Brandl
6c23616b2c merge with 1.0 2011-01-08 20:09:29 +01:00
Georg Brandl
c117b8524f Add link to standard markup description. 2010-09-10 09:05:00 +02: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
cb26c78079 Describe the "deprecated" directive. 2010-07-29 09:27:46 +02:00
Georg Brandl
bf767d5222 #454: Add more index markup capabilities: marking see/seealso entries, and main entries for a given key. 2011-01-07 19:00:29 +01:00
Georg Brandl
763789463d merge with 1.0 2011-01-06 20:59:33 +01:00
Georg Brandl
f925de6aa0 #586: Implemented improved glossary markup which allows multiple terms per definition. 2011-01-06 20:34:41 +01:00
Georg Brandl
3642b521ed merge with 1.0 2011-01-04 00:35:27 +01:00
Daniel Neuhäuser
7f254f1a77 Fixed a typo. Thanks to Thomas Waldmann for finding it. 2010-10-31 13:04:13 +01:00
Georg Brandl
242555d6ca merge with 1.0 2010-09-10 09:09:55 +02:00
Georg Brandl
ad759f54c1 #392: deprecate "centered". 2010-08-26 12:01:12 +00:00
Georg Brandl
40e692e6c3 #504: Add an `index` role, to make inline index entries. 2010-08-25 11:33:30 +00:00
Georg Brandl
2e520e5e7b #460: Allow limiting the depth of section numbers for HTML. 2010-08-25 09:59:53 +00:00
Georg Brandl
0f7072f028 Allow linking to tables just like figures with :ref:. 2010-05-30 12:11:52 +02:00
Georg Brandl
aaa89cbb24 Explain absolute paths in toctree. 2010-05-30 11:58:42 +02:00
Georg Brandl
f6c74a1319 Rename the extlink roles to avoid confusion between :rstdir: and :rst:dir:. 2010-05-24 13:06:55 +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
3e9182550a Review markup chapter. 2010-03-01 14:37:31 +01:00
Georg Brandl
9334d1537c Add some domain documentation. 2010-03-01 14:22:14 +01:00