Skip to content

Commit

Permalink
add missing docs.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ikreymer committed Mar 15, 2024
1 parent d223836 commit 3753f57
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/docs/develop/docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Documentation

This documentation is built with the [Mkdocs](https://www.mkdocs.org/) static site generator.

## Docs Setup

Python is required to build the docs, then run:

pip install mkdocs-material


## Docs Server

To start the docs server, simply run:

mkdocs serve

The documentation will then be available on `http://localhost:8000/`

The command-line options are rebuilt using the `docs/gen-cli.sh` script.

Refer to the [Mkdocs](https://www.mkdocs.org/) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) pages
for more info about the documentation.

0 comments on commit 3753f57

Please sign in to comment.