Setup documentation with MkDocs

[dalonsoa]

Documentation is an essential part of any software, but specially of open source. It is often seen as a burden or an afterthought, but it is actually key and it takes way less effort to write things as the code grows than leaving everything for the end.

MkDocs is a simple yet very powerful documentation framework that is easy to deploy in GitHub Pages, keeping docs and code hand in hand. It is relatively simple to get started and configure it, and once done, it is easy to keep it in sync, but I suggest to have a look at a project where we have used it, FINESSE:

• Repository: ImperialCollegeLondon/FINESSE: A graphical user interface for controlling and monitoring an interferometer device (github.com)
• Documentation page in GitHub Pages Hardware - FINESSE (imperialcollegelondon.github.io)