Skip to main content

Sphinx theme for F5 Networks

Project description

https://github.com/f5devcentral/f5-sphinx-theme/actions/workflows/test.yml/badge.svg

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

  1. pip install f5-sphinx-theme

  2. 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']}
  3. (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:

/screenshots/version.png

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.

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

f5_sphinx_theme-2.9.2.tar.gz (562.5 kB view details)

Uploaded Source

Built Distribution

f5_sphinx_theme-2.9.2-py2.py3-none-any.whl (568.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file f5_sphinx_theme-2.9.2.tar.gz.

File metadata

  • Download URL: f5_sphinx_theme-2.9.2.tar.gz
  • Upload date:
  • Size: 562.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for f5_sphinx_theme-2.9.2.tar.gz
Algorithm Hash digest
SHA256 ba28ac7f5917f68cff93aa23269ea88e8c8df47e6eba96eba599eebbaeca9f0e
MD5 241f4c407b93146f4a2902cd249ef975
BLAKE2b-256 025bb7c878359cec79ddedb4a7579e4992807d768514040d9924907d05d0e785

See more details on using hashes here.

File details

Details for the file f5_sphinx_theme-2.9.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for f5_sphinx_theme-2.9.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 54478726f3b7c4630499e2501c52dbe90427d1ad783dd735e869c868cd5da01d
MD5 39266b5b336c71f019a5433e7000f82a
BLAKE2b-256 fda1ba8a021417ede68a495adc1203de69b43adb7f068d769d50de3af867d7a9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page