niftools-sphinx-theme 0.1.0

A sphinx theme created to support niftools documentation

NifTools Sphinx theme was created to mimic the NifTools website, which is running a modified version of Yummy-Jekyl.

This theme is still in planning/development stage! Please wait until ver 1.0.0 before using this theme!

Features

Supports these extensions:

• ABlog

• autodoc

• autosectionlabel

• autosummary

• coverage

• doctest

• extlinks

• graphviz

• ifconfig

• imgconvertor

• inhertance_diagram

• intersphinx

• linkcode

• imgmath / mathjax

• napoleon

• todo

• viewcode

Templates

See More

• About Page

• Blog Page

• Projects Page

Installation

This theme can be found on PyPi and can be installed through pip

pip install --upgrade niftools_sphinx_theme

Inside your sphinx conf.py file you must put this inside

import niftools_sphinx_theme

extensions = [
    "niftools_sphinx_theme",
    ...
]

html_theme = "niftools_sphinx_theme"

Customization

This theme was created with customization is mind.

Development

I include the built files so all you have to do is run sphinx, but if you wish to work on this project we use webpack to compile and copy all CSS, JavaScript and fonts to the static folder.

Please read the contribution guide to understand what to do!