Home

Welcome to the f5-sphinx-theme wiki! This wiki provides usage information for the f5-sphinx-theme.

Branching Strategy

UPDATE The f5-sphinx-theme project follows a branching workflow. This change is required to give individual contributors access to the secure variables that allow the test script to deploy test documentation to the staging bucket for review. Travis doesn't make these variables available in pull request builds, which means PR-triggered builds cannot deploy test docs to staging.

Customizing CSS and Theme Assets

The css styling for the project uses three css files:

• f5.css contains F5's core Bootstrap customizations and fonts.
• f5-theme.css contains the core styles for the f5-sphinx-theme.
• custom.css can be added to your project at docs/_static/css. Use this file for any modifications you'd like to make for your documentation to make content easier to navigate and reference. All mods must still comply with the F5 Corporate Branding strategy and requirements.

NOTE: The theme relies on Bootstrap 3 and FontAwesome 4. Changing either version may have unintended consequences.

You can also use the extralinks.html file to add an extra links section to the bottom of the Table of Contents sidebar. To use it, add the file to the docs/_templates directory in your project.

Finally, the theme's layout is separated into a number of content blocks (content, f5sidebar, and main). Any of these blocks can be customized for individual projects. See the Sphinx Templating guide for instructions.

Styling Tools

Font Awesome

The f5-sphinx-theme uses the Font Awesome integration (v4.7.0) provided in the sphinxjp.theme.basicstrap Sphinx theme/extension. [1]

To use this extension in your project:

1. Add sphinxjp.themes.basicstrap to the extensions section of your project's conf.py.
2. Add sphinxjp.themes.basicstrap to your project's requirements.txt file.

To add a Font Awesome icon to your docs:

:fonticon:`fa fa-<icon_name>`

[1]	sphinxjp.themes.basicstrap is licensed under the MIT license.

Table Styling

The f5-sphinx-theme supports use of the Cloud Sphinx theme table styling extension.

To use this extension:

1. Add cloud_sptheme.ext.table_styling to the extensions section of your project's conf.py.
2. Add cloud_sptheme to your project's requirements.txt file.

Using specially-formatted TMSH/TMOS code blocks

The f5-sphinx-theme has special CSS styling for TMSH/TMOS code blocks. To use:

.. admonition:: TMSH

   tmsh show sys hardware

If you're including a multi-line print-out, format it as code, as shown below:

.. admonition:: TMSH

   ::

      admin@(bigip)(cfg-sync Standalone)(Active)(/mesos)# tmsh show ltm virtual
      ------------------------------------------------------------------
      Ltm::Virtual Server: basic-0_8080
      ------------------------------------------------------------------
      Status
        Availability     : unknown
        State            : enabled
        Reason           : The children pool member(s) either don't have service checking enabled, or service check results are not available yet
        CMP              : enabled
        CMP Mode         : all-cpus
        Destination      : 10.190.25.70:8080
      ...