docs: updating mkdocs documentation

- adding user guide section
- removing "baselevel: 4"
This commit is contained in:
Mose Müller 2023-10-11 13:57:38 +02:00
parent 106ffbfc40
commit 93c2f5ab70
3 changed files with 14 additions and 3 deletions

View File

@ -159,6 +159,9 @@ In this example, replace `<ip_addr>` with the IP address of the machine where th
<!--usage-end-->
## Understanding the Component System
<!-- Component User Guide Start -->
In `pydase`, components are fundamental building blocks that bridge the Python backend logic with frontend visual representation and interactions. This system can be understood based on the following categories:
### Built-in Type and Enum Components
@ -284,6 +287,8 @@ Below are the components available in the `pydase.components` module, accompanie
Users can also extend the library by creating custom components. This involves defining the behavior on the Python backend and the visual representation on the frontend. For those looking to introduce new components, the [guide on adding components](https://pydase.readthedocs.io/en/latest/dev-guide/Adding_Components/) provides detailed steps on achieving this.
<!-- Component User Guide End -->
## Understanding Service Persistence
`pydase` allows you to easily persist the state of your service by saving it to a file. This is especially useful when you want to maintain the service's state across different runs.

View File

@ -0,0 +1,7 @@
# Components Guide
{%
include-markdown "../../README.md"
start="<!-- Component User Guide Start -->"
end="<!-- Component User Guide End -->"
heading-offset=-2
%}

View File

@ -4,6 +4,8 @@ edit_uri: blob/docs/docs/
nav:
- Home: index.md
- Getting Started: getting-started.md
- User Guide:
- Components Guide: user-guide/Components.md
- Developer Guide:
- Developer Guide: dev-guide/README.md
- API Reference: dev-guide/api.md
@ -22,7 +24,6 @@ markdown_extensions:
- smarty
- toc:
permalink: true
baselevel: 4
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.snippets
@ -38,5 +39,3 @@ plugins:
watch:
- src/pydase