only : including content based on tags

Contents

• only : including content based on tags

  • Description

  • Example1

    • in conf.py

    • In a .rst file

Description

.. only:: <expression>

Include the content of the directive only if the expression is true. The expression should consist of tags, like this:

.. only:: html and draft

Undefined tags are false, defined tags (via the -t command-line option or within conf.py) are true. Boolean expressions, also using parentheses (like html and (latex or draft)) are supported.

The format of the current builder (html, latex or text) is always set as a tag.

New in version 0.6.

Example1

in conf.py

See also

• https://groups.google.com/forum/#!topic/sphinx-users/uUmSCiK-UtU

# tags.add('student')
# tags.add('stagiaire')
tags.add('prof')

In a .rst file

.. only prof

    Solution du problème