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
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
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
fb26a2a5fc
#14 : allow distinct programs for cmdoption directive.
2008-11-09 18:28:36 +01:00
Georg Brandl
7aa1c5eed2
#21 : allow short form for seealso arguments.
2008-11-04 21:35:05 +01:00
Georg Brandl
e666b6d203
Correct parameter name in example.
2008-11-04 08:20:18 +01:00
Georg Brandl
3206a6ab6f
Add a note about substitutions.
2008-10-25 16:00:53 +00:00
Georg Brandl
a857b89a23
UTF-8 isn't mandatory anymore.
2008-10-16 20:31:28 +00:00
Georg Brandl
47ce40c492
#16 : allow referring to figures without explicit text.
2008-09-24 15:36:34 +00:00
Georg Brandl
6a7e6315c2
Commit missing doc change.
2008-09-23 21:27:12 +00:00
Georg Brandl
7d3539c041
Add default highlight language selection support.
...
Add support for recognizing Python 3 console output.
2008-09-09 19:10:09 +00:00
Georg Brandl
e93af0e57c
Merged revisions 65566-65567,65623,65625 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x
........
r65566 | georg.brandl | 2008-08-07 09:11:11 +0000 (Thu, 07 Aug 2008) | 2 lines
Clarification for the ref role.
........
r65567 | georg.brandl | 2008-08-07 09:11:25 +0000 (Thu, 07 Aug 2008) | 2 lines
Rebuild everything if extensions change.
........
r65623 | georg.brandl | 2008-08-10 11:18:42 +0000 (Sun, 10 Aug 2008) | 2 lines
Unify handling of LaTeX escaping, and add some more replacements.
........
r65625 | georg.brandl | 2008-08-10 11:25:41 +0000 (Sun, 10 Aug 2008) | 2 lines
Make tex escapes a module.
........
2008-08-10 16:59:27 +00:00