Pre-release

This release is a pre-release and may not be stable for production use.

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.

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.

Copyright

Copyright 2017-18 F5 Networks Inc.

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 links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2.9.5)

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for f5networks from gravatar.com f5networks Avatar for jswongF5 from gravatar.com jswongF5

Credits

Author: F5 Networks

License

Apache Software License (Apache2)

Requires

Python >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*

Classifiers

Report project as malware

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.0.3b1.tar.gz (601.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

f5_sphinx_theme-2.0.3b1-py2.py3-none-any.whl (612.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file f5_sphinx_theme-2.0.3b1.tar.gz.

File metadata

  • Download URL: f5_sphinx_theme-2.0.3b1.tar.gz
  • Upload date:
  • Size: 601.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/2.7.15

File hashes

Hashes for f5_sphinx_theme-2.0.3b1.tar.gz
Algorithm Hash digest
SHA256 0e1d123ab56475417e4aef14d5ecf3b56f6dc8f0a9db2c8ce07a27d379b30aef
MD5 a6b936fa495647439613edb92b2add58
BLAKE2b-256 632ac96ff101d4ea44c0fc34eba4dc2e98d7e09fb6b8158e74bd194559d97580

See more details on using hashes here.

File details

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

File metadata

  • Download URL: f5_sphinx_theme-2.0.3b1-py2.py3-none-any.whl
  • Upload date:
  • Size: 612.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/2.7.15

File hashes

Hashes for f5_sphinx_theme-2.0.3b1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ef910596196ff5993613632374fe1794b861d483bfc3fcce05f412f3fa5d9fcd
MD5 778c187d119f16db9891a9607adac248
BLAKE2b-256 df1f7ff6d14b0c1dda894c380a5925877bdc8fe557c7bf6fa62f725d68066e31

See more details on using hashes here.

Release history Release notifications | RSS feed

2.9.5

2 files

2.9.4

2 files

2.9.3

2 files

2.9.2

2 files

2.9.1

2 files

2.9.0

2 files

2.8.0

2 files

2.7.0

2 files

2.6.1

2 files

2.6.0

2 files

2.5.2

2 files

2.5.0

2 files

2.4.2

2 files

2.4.1

2 files

2.4.0

2 files

2.3.0

2 files

2.2.5

2 files

2.2.4

2 files

2.2.3

2 files

2.2.2

2 files

2.2.1

2 files

2.2.0

2 files

2.1.1

2 files

2.1.0

2 files

2.0.8

2 files

2.0.7

2 files

Pre-release

2.0.7b0

2 files

2.0.6

2 files

Pre-release

2.0.6b1

2 files

2.0.5

2 files

Pre-release

2.0.5b1

2 files

2.0.4

2 files

Pre-release

2.0.4b1

2 files

2.0.3

2 files

This release
Pre-release

2.0.3b1 This release

2 files

2.0.2

2 files

Pre-release

2.0.2b9

2 files

Pre-release

2.0.2b8

2 files

Pre-release

2.0.2b7

2 files

Pre-release

2.0.2b6

2 files

Pre-release

2.0.2b5

2 files

Pre-release

2.0.2b4

2 files

Pre-release

2.0.2b2

2 files

Pre-release

2.0.2b1

2 files

2.0.1

2 files

2.0.0

2 files

Pre-release

2.0.0b6

2 files

Pre-release

2.0.0b5

2 files

Pre-release

2.0.0b4

2 files

Pre-release

2.0.0b2

2 files

Pre-release

2.0.0b1

2 files

1.0.9

2 files

1.0.8

2 files

Pre-release

1.0.8b2

2 files

Pre-release

1.0.8b1

2 files

1.0.7

2 files

Pre-release

1.0.7b1

2 files

1.0.6

2 files

Pre-release

1.0.6b1

2 files

1.0.5

2 files

Pre-release

1.0.5b1

2 files

1.0.4

2 files

Pre-release

1.0.3b4

2 files

Pre-release

1.0.3b2

2 files

Pre-release

1.0.3b1

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page