Skip to content
This repository was archived by the owner on Nov 10, 2017. It is now read-only.

mdn/sphinx-theme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mozilla Developer Network Sphinx Theme

Warning: This theme is broken, and won't be fixed. For details, see: bug 1361729

This is a version of the Mozilla Developer Network theme, for the Sphinx documentation engine. It was 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.

About

(Deprecated) Make Sphinx docs look like MDN

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 7