Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

A sphinx theme created to mimick niftools.org

Project Description

Installation

Via Python Package Interface

Download the package or add it to your requirements.txt file:

pip install niftools_sphinx_theme

In your conf.py file:

import niftools_sphinx_theme
html_theme = "niftools_sphinx_theme"
html_theme_path = [niftools_sphinx_theme.get_path()]

or (since v0.2.5):

html_theme = "niftools_sphinx_theme"

Via git or download

Download the niftools_sphinx_theme folder into your documentation at docs/_themes/ then add the following two settings to your Sphinx conf.py file:

html_theme = "niftools_sphinx_theme"
html_theme_path = ["_themes", ]

Configuration

The theme’s project-wide options are defined in the niftools_sphinx_theme/theme.conf file of this repository, and can be defined in your project’s conf.py via html_theme_options.

For example:

html_theme_options = {
    'home': 'https://github.com/TagnumElite',
    'projects': 'https://https://github.com/TagnumElite/?tab=repositories',
    'blog': 'https://tagnumelite.elitekast.com',
    'forums': 'https://forums.example.com',
    'youtube': 'CHANNEL_ID',
    'twitter': 'TagnumElite',
    'discord_id': 'Discord Server/Guild ID',
    'discord_invite': 'Discord Server/Guild Invite Url',
    'travis': 'user/repo',
    'appveyor': 'user/repo',
    'jenkins': 'user/repo',
    'coveralls': 'user/repo',
    'github': 'user/repo',
    'pypi': 'niftools_sphinx_theme'
}

If home is not specified in the theme_options it turns into the documentation home. If home is specified then there is a new option called Documentation on the navbar.

Changelog

0.0.7:

  • Re-Implement Bootstrap TOC to override Local TOC
  • TODO: Fix Global TOC (Made the global toc have an octicon for testing)
  • Enable the semi-broken TOC Affix

0.0.6:

  • Updated Classifiers
  • Made badges bool enabled
  • Updated Docs

0.0.5:

  • Add some more styling
  • Add travis support
  • Start work on a doc

0.0.4:

  • Removed Un-needed files and code
  • Moved CSS and JS into macros
  • Moved JS to the bottom
  • Improved TOC

0.0.3:

  • Fix description typo
  • Improve Header
  • Fix Project Classifiers
  • Move Script Import into head so that if a script breaks the whole thing doesn’t fail to import other scripts
  • Add more badges

0.0.2:

  • Add Readme

0.0.1:

  • Turn jekyll theme into sphinx theme
Release History

Release History

This version
History Node

0.0.7

History Node

0.0.6

History Node

0.0.5

History Node

0.0.4

History Node

0.0.3

History Node

0.0.2

History Node

0.0.1

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
niftools_sphinx_theme-0.0.7.tar.gz (842.5 kB) Copy SHA256 Checksum SHA256 Source Sep 13, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting