-
-
Notifications
You must be signed in to change notification settings - Fork 82
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |