-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Am 10.09.2010 08:53, schrieb Guenter Milde: > On 2010-09-08, Schollii wrote: > >>> Then it should become a recognized class argument. >>> Per definitionem in Docutils, rst options must be supported by every >>> writer. Class arguments can be savely ignored. > >>> Günter > >> Are there examples of class arguments? Sphinx doesn't mention anything >> about them. > > As with all reStructuredText markup that is kept unchanged, there is no > special Sphinx documentation. Sphinx just points to Docutils:: > > |more| See :ref:`rst-primer` for a more in-depth introduction to > reStructuredText and :ref:`sphinxmarkup` for a full list of markup > added by Sphinx. > > Unfortunately, there is no link in > http://sphinx.pocoo.org/markup/index.html#sphinxmarkup:: > > Sphinx adds a lot of new directives and interpreted text roles to > standard reST markup. This section contains the reference material > for these facilities. > > (IMO, `standard reST markup`_ should point to > > .. _standard reST markup: > http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html > )
Added. >> what is semantics of the string that comes after "class::"? By the >> looks of it, it is not something that is used much in sphinx. > > See http://docutils.sourceforge.net/docs/ref/rst/directives.html#class > > Unfortunately, there is a conflict with the Sphinx-added directive:: > > .. py:class:: name[(signature)] > > Describes a class. The signature can include parentheses with > parameters which will be shown as the constructor arguments. See > also Python Signatures. > > which in the default settings is aliased to ``.. class::`` > (see http://sphinx.pocoo.org/domains.html#directive-default-domain). > > Overcoming this clash was one of the reasons to introduce Sphinx > domains, however, I don't know how to achieve the standard meaning > for the ``.. class::`` directive with current Sphinx. If the default domain is None, or one that does not have a "class" directive, "class", will have its original meaning. It is always available as ``rst-class::``. cheers, Georg -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAkyJ2M8ACgkQN9GcIYhpnLDD7gCeMTuvbP4Yqsvc2UA5ymKr5vrL OvUAoJcdZ6LWjryt3hr8bJaPuZSaH907 =L6s6 -----END PGP SIGNATURE----- -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
