Skip to content

Latest commit

 

History

History
15 lines (10 loc) · 529 Bytes

README.md

File metadata and controls

15 lines (10 loc) · 529 Bytes

About the docs

This folder stores the contents of the official website. Each commit made here will be reflected on the documentation thanks to Read the Docs.

How to build the website locally

  • Install Sphinx
  • Open a console
  • Set your current directory to docs/
  • Run: sphinx-build . _build
  • Open docs/_build/index.html

Website update

  • Read the docs listens to the master branch, so changes from develop won't be visible until a release is made.