@@ -62,26 +62,35 @@ result = model.simulate(0.0, 10.0, 0.01)
6262
6363## Documentation
6464
65- 📚 ** [ Full Documentation] ( https://cyecca.readthedocs.io/ ) ** (or build locally with ` cd docs && make html ` )
65+ 📚 ** Full documentation:** Build locally with HTML output
66+ ``` bash
67+ cd docs && poetry run make html
68+ # Open docs/_build/html/index.html in your browser
69+ ```
70+
71+ ** Browse source files:**
72+ - [ Installation Guide] ( docs/user_guide/installation.rst )
73+ - [ Quick Start Tutorial] ( docs/user_guide/quickstart.rst )
74+ - [ Lie Groups Guide] ( docs/user_guide/lie_groups.rst )
75+ - [ Modeling Framework Guide] ( docs/user_guide/modeling.rst )
76+ - [ API Reference] ( docs/api/ ) (auto-generated from docstrings)
77+ - [ Jupyter Notebooks] ( notebook/ ) - Interactive examples
6678
67- ** Quick Links:**
68- - ** [ User Guide] ( docs/user_guide/index.rst ) ** - Installation, tutorials, concepts
69- - ** [ API Reference] ( docs/api/index.rst ) ** - Complete API documentation with doctests
70- - ** [ Jupyter Notebooks] ( notebook/ ) ** - Interactive examples and applications
79+ > ** Note:** Documentation is written in reStructuredText for Sphinx. For best viewing, build the HTML docs locally.
7180
7281## Modules
7382
7483### Lie Groups (` cyecca.lie ` )
7584Complete implementations of SO(2), SO(3), SE(2), SE(3), SE_2(3), and R^n with multiple parameterizations.
7685
7786** Key features:** Group operations, Lie algebra, Jacobians, conversions
78- ** Docs :** [ API Reference ] ( docs/api/lie.rst ) | [ User Guide] ( docs/user_guide/lie_groups.rst )
87+ ** Learn more :** [ Lie Groups Guide] ( docs/user_guide/lie_groups.rst )
7988
8089### Modeling Framework (` cyecca.model ` )
8190Type-safe declarative API for building hybrid dynamical systems with IDE autocomplete.
8291
8392** Key features:** Continuous/discrete states, events, DAE, composition, linearization
84- ** Docs :** [ API Reference ] ( docs/api/model.rst ) | [ User Guide] ( docs/user_guide/modeling.rst )
93+ ** Learn more :** [ Modeling Guide] ( docs/user_guide/modeling.rst )
8594
8695### Pre-Built Models (` cyecca.models ` )
8796Ready-to-use dynamics models: quadrotor, fixed-wing aircraft, RDD2 controller, Bezier trajectories
0 commit comments