The documentation for this project is built using MkDocs with the Material theme. The documentation utilizes Github actions which import Markdown files from multiple sources into this consolidated documentation repository.
-
Install documentation dependencies:
pip install -r requirements.txt
-
Start the documentation server:
mkdocs serve
-
View the documentation at http://localhost:8000
To build the documentation site without serving it run mkdocs build.
The built site will be in the site directory. The serve function also watches for changes in the documents and builds the site automatically
See the Contributing guide for development setup instructions.
The documentation is published from this repository as a web site in Github pages in address docs.silogen.ai. The deployment can be done locally with the command mkdocs gh-deploy.