Getting Started

Sphinx is a documentation site generator. Essentially you write your documentation in Markdown or reStructuredText (reST) files and Sphinx will build those files into HTML, JavaScript, and CSS, and serve it to a webserver for you.

Presque Labs Sphinx is hosted on presque-gamma, and is based on sphinx-autobuild, a version of Sphinx that detects changes in the base directory (in this case, /presquedrive/server-config/autosphinx/data), and then rebuilds the site automatically when it does detect a change.

Therefore, to modify this site, you must modify the files in /presquedrive/server-config/autosphinx/data. There’s a myriad of ways you can do this (jupyter, RDP, shellinabox)