Initiate mkdocs

This commit is contained in:
Julien Zoubian 2024-09-04 23:18:22 +02:00
parent 33e0df1c63
commit 26272aff90
3 changed files with 18 additions and 1 deletions

View file

@ -234,4 +234,3 @@ For simulation testing, follow these steps:
- [ ] migrate existing test (see wiki) - [ ] migrate existing test (see wiki)
- [ ] doc test ? - [ ] doc test ?
- [ ] Initiate unit test - [ ] Initiate unit test

17
docs/index.md Normal file
View file

@ -0,0 +1,17 @@
# Welcome to MkDocs
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
## Commands
* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.
## Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.

1
mkdocs.yml Normal file
View file

@ -0,0 +1 @@
site_name: My Docs