docs(docs): adding initial mkdocs build

This commit is contained in:
Scott Lyons 2024-08-21 10:57:37 -07:00
commit 67c8456a22
4 changed files with 77 additions and 0 deletions

View file

@ -0,0 +1,22 @@
# 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.
## Autodoc example
::: szurubooru_client.SzurubooruSyncClient
:docstring: