Commit Graph

85 Commits

Author SHA1 Message Date
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
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
Georg Brandl
a734207eea fix markup 2009-08-26 14:30:23 +00:00
Georg Brandl
d3b0d6a105 merge with trunk 2009-08-09 22:46:16 +02:00
Georg Brandl
137f37b2fc merge with 0.6 2009-08-06 23:03:49 +02:00
Georg Brandl
c32186282f #222: Allow the "Footnotes" header to be translated. 2009-08-06 22:48:14 +02:00
Georg Brandl
9fce647b14 merge with 0.6 2009-09-03 18:24:04 +02:00
Georg Brandl
fdf4bf4154 merge with 0.6 2009-06-15 18:36:22 +02:00
Georg Brandl
61a55f095b Remove misguided recommendation to use emphasis for variables. 2009-06-15 17:43:32 +02:00
Georg Brandl
c02b7149aa Move domain-specific code around a bit; builtin domains are now completely in sphinx.domains. Test suite does not pass yet. 2009-07-05 12:24:27 +02:00
Georg Brandl
fb0791bdfc Added the `prepend and append` options to the
``literalinclude`` directive.
2009-06-04 17:57:58 +02:00
Georg Brandl
4de4dcccd4 #123: The `glossary directive now supports a :sorted:`
flag that sorts glossary entries alphabetically.
2009-03-15 23:34:19 +01: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
2f13231fbd merge with 0.5 2009-02-23 19:24:02 +01:00
Georg Brandl
cadb5af9f1 Note that Python code in code blocks is parsed. 2009-02-23 19:23:08 +01:00
Georg Brandl
4c81b055c8 Added an `only` directive that can selectively include text
based on enabled "tags".  Tags can be given on the command
line.  Also, the current builder output format (e.g. "html" or
"latex") is always a defined tag.
2009-02-19 21:56:34 +01:00
Georg Brandl
f07d0afef2 Note how to change default role. 2008-12-28 21:29:40 +01:00
Georg Brandl
c49d8217e9 Fix #70: clarify meaning of |today|. 2008-12-15 10:26:07 +01:00
Georg Brandl
21f78a9771 Fix target. 2009-02-15 20:08:31 +01:00
Georg Brandl
106ef21629 More templating docs. 2009-02-15 11:38:23 +01:00
Georg Brandl
aedbdd953d Fix more line length and trailing whitespace. 2009-01-10 22:18:18 +01:00
Georg Brandl
c83d630fd8 Close #52: There is now a `hlist` directive, creating a compact
list by placing distributing items into multiple columns.
2009-01-04 22:00:40 +01:00
Georg Brandl
9fc2437773 Document new literalinclude options. 2009-01-02 00:32:02 +01:00
Georg Brandl
c80dc58ac1 Rename "object" to "pyobject" and document it. 2008-12-30 15:45:02 +01:00
Georg Brandl
f13c3a00cd Close #23: Added a `classmethod directive along with method`
and ``staticmethod``.
2008-12-29 00:11:06 +01:00