mirror of
https://github.com/tiqi-group/pydase.git
synced 2025-06-11 07:47:12 +02:00
Adding mkdocs config and docs folder
This commit is contained in:
0
docs/about/contributing.md
Normal file
0
docs/about/contributing.md
Normal file
10
docs/about/license.md
Normal file
10
docs/about/license.md
Normal file
@ -0,0 +1,10 @@
|
||||
License
|
||||
=======
|
||||
`pydase` is released under the *MIT license*:
|
||||
|
||||
```{.license}
|
||||
{%
|
||||
include "../../LICENSE"
|
||||
comments=false
|
||||
%}
|
||||
```
|
0
docs/about/release-notes.md
Normal file
0
docs/about/release-notes.md
Normal file
3
docs/css/extra.css
Normal file
3
docs/css/extra.css
Normal file
@ -0,0 +1,3 @@
|
||||
.language-license{
|
||||
background-color: #eeffcc !important;
|
||||
}
|
7
docs/dev-guide/README.md
Normal file
7
docs/dev-guide/README.md
Normal file
@ -0,0 +1,7 @@
|
||||
# Developer Guide
|
||||
|
||||
Extending `pydase`.
|
||||
|
||||
---
|
||||
|
||||
- [API Reference](api.md)
|
0
docs/dev-guide/api.md
Normal file
0
docs/dev-guide/api.md
Normal file
13
docs/getting-started.md
Normal file
13
docs/getting-started.md
Normal 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
1
docs/index.md
Normal file
@ -0,0 +1 @@
|
||||
{% include-markdown "../README.md" %}
|
Reference in New Issue
Block a user