Skip to content

F5 sphinx theme Wiki

Jump to bottom
Jodie Putrino edited this page Jun 27, 2017 · 1 revision

Usage

The f5-sphinx-theme is intended for use by projects under development in either the F5 Networks or F5 DevCentral GitHub orgs.

There are a number of helpful extensions and tools built in that improve the look and feel of documentation using the f5-sphinx-theme.

  • Support for Font Awesome icons (and other awesome things) from sphinxjp-themes-basicstrap. These can be added anywhere in rST docs using

    :fonticon:`fa fa-<icon_name>`

  • Support for additional table formatting options from the Cloud Sphinx theme.

  • Special admonition for TMSH commands:

    .. admonition:: TMSH

   tmsh show sys hardware

  • Special admonition for "to-dos":

    .. todo:: 

   Something that you need to do
Clone this wiki locally