Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

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
                         }
    

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.

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

History Node

1.0.3b4

History Node

1.0.3b2

History Node

1.0.3b1

This version
History Node

1.0.2

History Node

1.0.1

History Node

1.0.0

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.2-py2.py3-none-any.whl (342.5 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Mar 30, 2018
f5_sphinx_theme-1.0.2.tar.gz (2.9 kB) Copy SHA256 hash SHA256 Source None Mar 30, 2018

Supported by

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