Sphinx theme for F5 Networks
Project description
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 }
Depending on your publication/deployment process, you may have to re-build your documentation for the changes to take effect.
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 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
Built Distribution
Hashes for f5_sphinx_theme-1.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 91da03abf1eac7c55b283d08a7d66484bbb537fd616bb5899626a482b162b001 |
|
MD5 | f5b7124abc366f427c9ffbcc4dd009aa |
|
BLAKE2b-256 | a9a12f3b6b4f1c9c6e755d02d65b8b7fa30f084f7007ce43c1f3ea10704e5b8b |