Skip to main content

A Sphinx theme for the Mozilla Developer Network

Project description

This is a version of the Mozilla Developer Network theme, for the Sphinx documentation engine. It is used for the Kuma development documentation.

Here is how I use it

To use it, you need to clone it somewhere in your Sphinx’s architecture:

$ pip install mdn-sphinx-theme

and to configure Sphinx to use it. In your conf.py file:

import mdn_theme

html_theme_path = [mdn_theme.get_theme_dir()]
html_theme = 'mdn'

Take care and remove the pygments_style configuration, as it may not be of the better taste with the mozilla’s theme.

Any contributions are of course welcome!

Readthedocs

Add a pip requirements file to your project and have the following packages listed there:

Sphinx
mdn-sphinx-theme

Then configure your Readthedocs project to use that requirement file before rendering your project’s documentation.

Project details


Download files

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

Files for mdn-sphinx-theme, version 2016.0
Filename, size File type Python version Upload date Hashes
Filename, size mdn_sphinx_theme-2016.0-py2-none-any.whl (393.8 kB) File type Wheel Python version 2.7 Upload date Hashes View
Filename, size mdn-sphinx-theme-2016.0.tar.gz (393.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page