README.md

Brainhack school documentation

This is the technical documentation of the BrainHack School (BHSchool). The most recent version of the docs is published on school-brainhack.readthedocs.org. The docs are built using the sphinx library. Content is mostly composed of markdown files (with a few .rst) located in docs/source, and the website itself is located in docs/build. All source changes on the master branch will automatically update the website, through integration with readthedocs. To test updates to the website locally, clone or download this repository, install the dependencies (python3) using:

pip install -r requirements.txt

and then type

cd docs
make html

which will update the content inside build. Note that some changes (e.g. change in the table of content) require to delete the content of build before compiling in order to get a clean build.

Here is an overview of the content files, which are located inside the source folder:

• index.rst: this describes the documents to include in the documentation, as a list of files. For example, the line REVIEWER means that REVIEWER.md will be included (it is not necessary to add the extension).
• OVERVIEW.rst: content of the landing page.
• <FILE>.md: a section of the documentation, in markdown format. For example REVIEWER.md. This content needs to be listed in index.rst in order to be included in the documentation. It is not automatically detected.
• img: this folder contains images. It can be referenced as img/my_img.png in the docs.
• _static: this folder contains document that are linked inside the documentation.