DAPLAB Public Documentation
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
.gitignore
README.md
mkdocs.yml
pom.xml
publish-doc.sh

README.md

DAPLAB Official Documentation

This repo holds the official documentation of the DAPLAB, compiled and deployed at the following URL: https://docs.daplab.ch

This documentation is hosted with ❤ by the DAPLAB team.

The current documentation relies havily on Markdown for the syntaxe and Mkdocs for the static generation.

Build the doc

mkdocs compile

This will produce a folder site with the static site inside.

Deploy the doc

The documentation is hosted on vsccproxy1-brn. Once the the site folder is up-to-date, you can simply rsync the folder to the proxy server.

rsync -av site/ daplab-wn-12:/var/www/docs.daplab.ch

A convenient script, generate-docs.sh, is capturing all that. Just launch it to deploy the new version

./publish-doc.sh

References

Simplify your life generating Markdown Tables