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.

Source Distribution

mdn-sphinx-theme-2016.0.tar.gz (393.8 kB view details)

Uploaded Source

Built Distribution

mdn_sphinx_theme-2016.0-py2-none-any.whl (393.8 kB view details)

Uploaded Python 2

File details

Details for the file mdn-sphinx-theme-2016.0.tar.gz.

File metadata

File hashes

Hashes for mdn-sphinx-theme-2016.0.tar.gz
Algorithm Hash digest
SHA256 fb9656d2047f35e71ec30c62258ddb6020cfa3de060445f91f0965189e6e0679
MD5 55c6593cc8daedab4c93716c2f4188e4
BLAKE2b-256 19f8ba716650bd05acfbcfd52795fd1b0e7f20d54d04892d1777979b366616cd

See more details on using hashes here.

Provenance

File details

Details for the file mdn_sphinx_theme-2016.0-py2-none-any.whl.

File metadata

File hashes

Hashes for mdn_sphinx_theme-2016.0-py2-none-any.whl
Algorithm Hash digest
SHA256 a42ab9cba1ec3257d669f6817ade877717b6b430242b5bf3777b4762bba7ef29
MD5 51d5193860c8ae6dd8a9ed669f767b29
BLAKE2b-256 086e378657ec0b47816911326572a527c50a29bc5be331fc3a52f0c81c102a70

See more details on using hashes here.

Provenance

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