0
0
mirror of https://github.com/bec-project/bec_widgets.git synced 2025-07-13 19:21:50 +02:00

docs: added api reference; closes #123

This commit is contained in:
2024-03-26 21:48:46 +01:00
parent ea4d743a25
commit 88014d24c1
2 changed files with 21 additions and 1 deletions

View File

@ -1,6 +1,14 @@
(developer)=
# Development
```{toctree}
---
maxdepth: 1
hidden: true
---
reference/
```
To contribute to the development of BEC Widgets, start by setting up the development environment:
1. **Clone the Repository**:
@ -13,4 +21,6 @@ cd bec-widgets
Installing the package in editable mode allows you to make changes to the code and test them in real-time.
```bash
pip install -e .[dev]
```
```

View File

@ -0,0 +1,10 @@
## API Reference
```{eval-rst}
.. autosummary::
:toctree: _autosummary
:template: custom-module-template.rst
:recursive:
bec_widgets
```