f5-sphinx-theme

The f5-sphinx-theme provides F5 Networks styling and layouts for projects built with Sphinx. This theme should not be used without modification for any project that doesn’t publish documentation to clouddocs.f5.com.

Setup and Configuration

pip install f5-sphinx-theme

Update your project’s conf.py with the following settings:

import f5_sphinx_theme
html_theme = 'f5_sphinx_theme'
html_sidebars = {'**': ['searchbox.html', 'localtoc.html', 'globaltoc.html']}

(Optional) Set the html_theme_options{} dictionary. Supported options are shown below.

html_theme_options = {
                        'site_name': '<desired site name>',           \\ DEFAULTS TO "CloudDocs home"
                        'next_prev_link': True or False,              \\ DEFAULTS TO FALSE
                        'html_last_updated_fmt': '%Y-%m-%d %H:%M:%S', \\ REQUIRED FOR FEDERATED SEARCH, DO NOT CHANGE
                        # 'surveymonkey_url' = '',                    \\ DEFAULTS TO ''
                        # 'medallia_embed_url' = '',                  \\ DEFAULTS TO ''
                        # 'qualtric_id' = '',                         \\ DEFAULTS TO ''
                        # 'qualtrics_url' = '',                       \\ DEFAULTS TO ''
                        # 'medallia_id' = '',                         \\ DEFAULTS TO "medallia_inline_survey"
                        # 'feedback_exclude_pages': ['page.html'],    \\ DEFAULTS TO ['index.html', 'search.html'], THE TABLE OF CONTENTS AND SEARCH PAGE
                        # 'base_url' = ''                             \\ DEFAULTS TO '/',
                        # 'sidebar_toc_maxdepth' = ''                 \\ DEFAULTS TO '', Override 'maxdepth' behavior on sidebar toc in layout.html. This is an integer value.
                        # 'hide_right_menu': True or False,           \\ DEFAULTS TO FALSE
                        # 'hide_right_menu_home': True or False       \\ DEFAULTS TO FALSE, Only hide right menu on main home page
                        # 'next_prev_link_skip_index': True or False, \\ DEFAULTS TO FALSE. Hide Next and Previous buttons from all 'index' pages?
                        # 'display_last_updated': False,              \\ DEFAULTS TO FALSE.
                        # 'banner_msg': '',                           \\ DEFAULTS TO ''
                        # 'show_project': True,                       \\ DEFAULTS TO TRUE. Show project and version in left menu
                        # 'dropdown': {                               \\ DEFAULTS TO ''. Enable dropdown menu
                        #   'name': 'SPK v1.9.1',
                        #   'links': {
                        #     'SPK v1.9.0': '/service-proxy/1.9.0/intro.html',
                        #     'SPK v1.8.2': '/service-proxy/1.8.2/intro.html'
                        #   }
}
                     }

The base_url theme option is intended to allow customization of the root URL.

Version Selector

You can add a version selector to the navbar, as shown below:

The version selector is not enabled by default. To enable it, add the following settings to your docs/conf.py:

html_theme_options = {
  'version_selector': True,
}

html_context = {
  'version_meta_path': 'uri/of/your/json/versions/file.json',
  'project_safe': re.sub('[^A-Za-z0-9]+', '', project)
}

The 'version_meta_path' refers to the location of a version.json file in the host S3 bucket. The versions displayed in the version selector are generated from this JSON file via an AJAX call. You only need to update one file to make the change across all versions. Generating the JSON is left up to the implementor (i.e., you), but it can be incorporated into a CI/CD process. Ideally, the JSON should be at the root of the project directory in S3, with versions being in subfolders as shown here:

project_root
  |
  +---versions.json
  |
  +---v2.0.0
  |   \--- <docs_html>
  |
  +---v1.0.1
  |   \--- <docs_html>
  |
  +---v1.0.0
      \--- <docs_html>

See the [test](/test) directory in this repo for a basic example.

Usage

See the project wiki for more information.

Testing

This project uses GitHub Actions for CI/CD.

Copyright

License

Apache V2.0

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Release files for f5-sphinx-theme 2.9.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for f5-sphinx-theme 2.9.5
File	Size	Uploaded
f5_sphinx_theme-2.9.5.tar.gz	562.3 kB	Jun 18, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for f5-sphinx-theme 2.9.5
File	Interpreter	ABI	Platform	Reset
f5_sphinx_theme-2.9.5-py2.py3-none-any.whl 568.4 kB Jun 18, 2026	Python 3, Python 2	none	any	Details

Total release size: 1.1 MB

Release files / f5_sphinx_theme-2.9.5.tar.gz

Download URL	f5_sphinx_theme-2.9.5.tar.gz
Size	562.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`af448d7cc6486e577446c8ef27ab48d8310991d1b66791f1883585c117cc1eab`
BLAKE2b-256 checksum How to use checksums	`ea8247da6435ce8342feea966a35b84b0c7f46ee2c468bdf6aca97851d472bd7`
Upload date	Jun 18, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.13.12`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/f5devcentral/f5-sphinx-theme
Publishing commit: github.com/f5devcentral/f5-sphinx-theme/tree/c25fb85d6c064aaeb99d130fbabf38b78f36a14e

Workflow

Publishing configuration: github.com/f5devcentral/f5-sphinx-theme/blob/c25fb85d6c064aaeb99d130fbabf38b78f36a14e/.github/workflows/publish.yml
Publishing logs: github.com/f5devcentral/f5-sphinx-theme/actions/runs/27776056923/attempts/1

Artifact

Subject: f5_sphinx_theme-2.9.5.tar.gz
SHA-256 checksum: af448d7cc6486e577446c8ef27ab48d8310991d1b66791f1883585c117cc1eab Verifying attestations

Release files / f5_sphinx_theme-2.9.5-py2.py3-none-any.whl

Download URL	f5_sphinx_theme-2.9.5-py2.py3-none-any.whl
Size	568.4 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`5341e6e8a30b21d2083984f55377b0618dc6fc28a1797c7b1733751e72638ac2`
BLAKE2b-256 checksum How to use checksums	`49fe103933b79d9d294f91e024d6d2d37c923f8c6b48da5402cebd24570e57f1`
Upload date	Jun 18, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.13.12`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/f5devcentral/f5-sphinx-theme
Publishing commit: github.com/f5devcentral/f5-sphinx-theme/tree/c25fb85d6c064aaeb99d130fbabf38b78f36a14e

Workflow

Publishing configuration: github.com/f5devcentral/f5-sphinx-theme/blob/c25fb85d6c064aaeb99d130fbabf38b78f36a14e/.github/workflows/publish.yml
Publishing logs: github.com/f5devcentral/f5-sphinx-theme/actions/runs/27776056923/attempts/1

Artifact

Subject: f5_sphinx_theme-2.9.5-py2.py3-none-any.whl
SHA-256 checksum: 5341e6e8a30b21d2083984f55377b0618dc6fc28a1797c7b1733751e72638ac2 Verifying attestations