Skip to main content

A sphinx theme created to support niftools documentation

Project description

PyPi Version Build Status License Code Style: Black

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:

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.

Project details


Download files

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

Source Distribution

niftools_sphinx_theme-0.3.3.tar.gz (1.2 MB view hashes)

Uploaded Source

Built Distributions

niftools_sphinx_theme-0.3.3-py3.7.egg (1.2 MB view hashes)

Uploaded Source

niftools_sphinx_theme-0.3.3-py2.py3-none-any.whl (1.2 MB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page