summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-02-28 19:30:30 +0100
committerGeorg Brandl <georg@python.org>2010-02-28 19:30:30 +0100
commit19eabfa2a8d4ef42f4b4a1560d49e2c0a7b1a85e (patch)
treea5cb0218b458536ec7c16d58eff903ce882a2c00 /doc
parentc091fb455490a7a00854a30f410f1a824bae232c (diff)
downloadsphinx-19eabfa2a8d4ef42f4b4a1560d49e2c0a7b1a85e.tar.gz
Re-export docutils .. class:: as .. rst-class:: and un-document .. cssclass::.
Diffstat (limited to 'doc')
-rw-r--r--doc/markup/desc.rst4
-rw-r--r--doc/rest.rst7
2 files changed, 7 insertions, 4 deletions
diff --git a/doc/markup/desc.rst b/doc/markup/desc.rst
index c8dec77c..eb7de7c3 100644
--- a/doc/markup/desc.rst
+++ b/doc/markup/desc.rst
@@ -187,10 +187,6 @@ The directives are:
The first way is the preferred one.
- .. versionadded:: 0.4
- The standard reST directive ``class`` is now provided by Sphinx under
- the name ``cssclass``.
-
.. directive:: .. attribute:: name
Describes an object data attribute. The description should include
diff --git a/doc/rest.rst b/doc/rest.rst
index aa294391..2dff0996 100644
--- a/doc/rest.rst
+++ b/doc/rest.rst
@@ -281,6 +281,7 @@ Docutils supports the following directives:
- :rstdir:`raw` (include raw target-format markup)
- :rstdir:`include` (include reStructuredText from another file)
+ - :rstdir:`class` (assign a class attribute to the next element) [1]_
* HTML specifics:
@@ -451,3 +452,9 @@ There are some problems one commonly runs into while authoring reST documents:
* **No nested inline markup:** Something like ``*see :func:`foo`*`` is not
possible.
+
+
+.. rubric:: Footnotes
+
+.. [1] When the default domain contains a :dir:`class` directive, this directive
+ will be shadowed. Therefore, Sphinx re-exports it as :dir:`rst-class`.