Documentation for the (bio-)SAXS instrument of the Structural Biology platform located in the department of biochemistry and molecular medicine of the Université de Montréal.
Tutorials and howtos are presented in this documentation, formatted using MkDocs, and the theme Cinder.
To access the site: http://airen.bcm.umontreal.ca/biostruct/SAXS_tutorials/
First install the required Python distribution packages:
pip install -r requirements.txt
This will install the following (and associated requirements):
- MkDocs (
mkdocs) - MkDocs Cinder theme (
mkdocs-cinder) - Math extension for Python-Markdown (
python-markdown-math) - MkDocs Bootstrap tables plugin (
mkdocs-bootstrap-tables-plugin)
Then serve the website locally with MkDocs:
mkdocs serve
By default, the documentation will be available in your browser at this address: http://127.0.0.1:8000/.
First install the required Python distribution packages:
pip install -r requirements.txt
This will install the following (and associated requirements):
- MkDocs (
mkdocs) - MkDocs Cinder theme (
mkdocs-cinder) - Math extension for Python-Markdown (
python-markdown-math) - MkDocs Bootstrap tables plugin (
mkdocs-bootstrap-tables-plugin)
Then build the website with MkDocs
mkdocs build
Finally, copy the static site files to the root folder of your web server:
cp -r site/* /path/to/server/root
The site should then be available online. Make sure you adjust the /path/to/server/root to match the configuration of web server.
More information here.