Skip to main content

Sphinx theme for F5 Networks

Project description

https://travis-ci.org/f5devcentral/f5-sphinx-theme.svg?branch=master

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
                            # 'base_url' = ''                            \\ DEFAULTS TO '/'
                         }
    

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

    For example, you can change the base_url setting to “https://clouddocs.f5networks.net” when deploying docs to the staging site.

Note

Depending on your publication/deployment process, you may have to re-build your documentation for the changes to take effect.

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 Travis-CI 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


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
f5_sphinx_theme-1.0.6-py2.py3-none-any.whl (389.7 kB) Copy SHA256 hash SHA256 Wheel py2.py3
f5_sphinx_theme-1.0.6.tar.gz (383.4 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page