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..

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-0.3.tar.gz (388.1 kB view details)

Uploaded Source

File details

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

File metadata

File hashes

Hashes for mdn-sphinx-theme-0.3.tar.gz
Algorithm Hash digest
SHA256 10b9f4db8520e8e7893fc8412fd4fbc644b1c8b811cc0e371c1cbcddcad14b01
MD5 31f46b6e0c1339021ff962a41fa3cd82
BLAKE2b-256 23082c9e370420eefe739d71520c852a4b9646b6aab1fd07a10a45b3192ba965

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