Adding mkdocs config and docs folder

This commit is contained in:
Mose Müller
2023-08-04 12:02:56 +02:00
parent 0e8970f0c5
commit da28b6c82c
10 changed files with 82 additions and 3 deletions

View File

10
docs/about/license.md Normal file
View File

@ -0,0 +1,10 @@
License
=======
`pydase` is released under the *MIT license*:
```{.license}
{%
include "../../LICENSE"
comments=false
%}
```

View File

3
docs/css/extra.css Normal file
View File

@ -0,0 +1,3 @@
.language-license{
background-color: #eeffcc !important;
}

7
docs/dev-guide/README.md Normal file
View File

@ -0,0 +1,7 @@
# Developer Guide
Extending `pydase`.
---
- [API Reference](api.md)

0
docs/dev-guide/api.md Normal file
View File

13
docs/getting-started.md Normal file
View File

@ -0,0 +1,13 @@
# Installation
{%
include-markdown "../README.md"
start="<!--installation-start-->"
end="<!--installation-end-->"
%}
# Usage
{%
include-markdown "../README.md"
start="<!--usage-start-->"
end="<!--usage-end-->"
%}

1
docs/index.md Normal file
View File

@ -0,0 +1 @@
{% include-markdown "../README.md" %}