niftools-sphinx-theme 0.0.7 2017-09-13 ✔ PY3

niftools-sphinx-theme on PyPI  

A sphinx theme created to mimick niftools.org


AuthorTagan Hoyle
LicenseMIT

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