You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
32 lines
727 B
32 lines
727 B
# Documentation
|
|
|
|
This directory contains the project documentation.
|
|
|
|
## Structure
|
|
|
|
```
|
|
docs/
|
|
├── api/ # API reference documentation
|
|
├── guides/ # User guides and tutorials
|
|
├── examples/ # Example code and notebooks
|
|
└── index.rst # Main documentation index
|
|
```
|
|
|
|
## Building Documentation
|
|
|
|
To build the documentation locally:
|
|
|
|
```bash
|
|
cd docs
|
|
pip install sphinx sphinx-rtd-theme
|
|
make html
|
|
```
|
|
|
|
The built documentation will be available in `docs/_build/html/`.
|
|
|
|
## Documentation Style
|
|
|
|
- Use Google-style docstrings for all modules, classes, and functions
|
|
- Include type hints in function signatures
|
|
- Provide examples in docstrings where appropriate
|