Document how to build Sphinx based docs locally

RESOLVED FIXED

Status

developer.mozilla.org
Setup / Install
--
enhancement
RESOLVED FIXED
4 years ago
a year ago

People

(Reporter: jezdez, Unassigned)

Tracking

Details

(Whiteboard: [specification][type:feature])

(Reporter)

Description

4 years ago
What problems would this solve?
===============================
This would help both developers as well as contributors to make document easier.

Who would use this?
===================
developers & contributors

What would users see?
=====================
A documentation page

What would users do? What would happen as a result?
===================================================
Read it and use it

Is there anything else we should know?
======================================
(Reporter)

Updated

4 years ago
Component: General → Setup / Install
Severity: normal → enhancement
From my notes: 

1. ./manage.py generate_sphinx_template > layout.html
2. git clone git@github.com:mozilla/mdn-sphinx-theme.git
3. cp layout.html /path/to/mdn-sphinx-theme/mdn_theme/mdn/
4. pip install -e /path/to/mdn-sphinx-theme
5. cd docs
6. make html
7. open _build/html/index.html
Fixed in August 2016 in mozilla/kuma#3954
Status: NEW → RESOLVED
Last Resolved: a year ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.