Skip to content

Latest commit

 

History

History
25 lines (16 loc) · 956 Bytes

CONTRIBUTING.rst

File metadata and controls

25 lines (16 loc) · 956 Bytes

Contributing Documentation

If you would like to contribute to this documentation you can edit pages directly on github, else branch, or fork and send us a pull request.

The documentation is published on Read The Docs

To test larger changes to the documentation you can build and run it with the python engine:

pip install --upgrade pip
pip install sphinx sphinx-autobuild
pip install sphinx_rtd_theme
cd docs; make clean ; sphinx-autobuild . _build/html

The docs should start at http://127.0.0.1:8000/

Documentation House Rules

  • No email address domains to avoid spam to DfE email servers. Save typing and write simon.massey or jenny.researcher@digital
  • No links to the pilot platform as they are likely to change weekly. Registered users should get the current links from the platform itself.