Conditional output in Sphinx Documentation

前端 未结 1 2056
无人共我
无人共我 2020-12-09 03:37

I\'m writing some documentation with Sphinx and I\'d like to print out a certain block of text only for HTML documentation, not for LaTeX documentation. Something tells me I

相关标签:
1条回答
  • 2020-12-09 04:11

    No extension is required. Just use the only directive.

    (old link, from original 2010 post)
    https://web.archive.org/web/20100129001557/http://sphinx.pocoo.org/markup/misc.html#including-content-based-on-tags

    (latest link)
    https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#including-content-based-on-tags

    It works like this:

    .. only:: latex
    
        The stuff in here only appears in the latex output.
    
    .. only:: html
    
        The stuff in this block only appears in the HTML output. It's
        often useful to use this directive with it:
    
        .. raw:: html
    
            It's good for embedding stuff, like video.
    
    0 讨论(0)
提交回复
热议问题