Commit Graph
109 Commits
Author SHA1 Message Date
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
Georg Brandl f36592e418 Begin the Great Refactoring of the docs.
* Move sphinx-build option description from intro to a new document.
* Move toctree information to a new document in markup/.
* Add a tutorial document placed after intro. Begin filling it in.
2010-02-28 22:00:22 +01:00
Georg Brandl 7f1eafb9a3 Re-export docutils .. class:: as .. rst-class:: and un-document .. cssclass::. 2010-02-28 19:30:30 +01:00
Georg Brandl 0feb7dacf2 Add a bit more content to the reST primer, and add links to the reST reference docs for all constructs. 2010-02-28 17:24:55 +01:00
Georg Brandl 832e290acd Add "orphan" metadata entry to suppress non-toctree-inclusion warnings. 2010-02-25 22:49:54 +01:00
Georg Brandl 538886ab94 A bit of domain documentation. 2010-01-17 19:16:18 +01:00
Georg Brandl 1a7403bed8 Add doc for new doc field syntax. 2010-01-17 19:05:19 +01:00
Georg Brandl 2a2a66a923 merge with trunk 2010-01-08 18:55:35 +01:00
Georg Brandl c80f52dfbf Added `tab-width option to literalinclude` directive. 2010-01-08 18:36:58 +01:00
Georg Brandl d12ad380f2 Finish renaming description units to object (description)s. 2009-10-27 19:58:40 +01:00
Georg Brandl efa4678cfd Add some XXX comments to places where work is needed. 2009-09-08 12:07:11 +02:00
Georg Brandl 3e91b3cd64 merge 2009-09-02 17:32:48 +00:00