File size: 1,794 Bytes
1f3a93e | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 | # Documentation
This directory contains the source code for the GR00T-WholeBodyControl documentation website.
## Building Locally
### Prerequisites
Install the required Python packages:
```bash
pip install sphinx sphinx-book-theme sphinx-design sphinxemoji \
autodocsumm sphinxcontrib-bibtex myst-parser \
sphinx-copybutton
```
### Build the Documentation
```bash
cd docs
make html
```
The built documentation will be in `build/html/`. Open `build/html/index.html` in your browser.
### Live Preview
Start a local web server to preview:
```bash
cd build/html
python -m http.server 8000
```
Then open http://localhost:8000
### Clean Build
To remove all built files and rebuild from scratch:
```bash
make clean
make html
```
## Deployment
The documentation is automatically built and deployed to GitHub Pages when changes are pushed to the `main` branch via the GitHub Actions workflow at `.github/workflows/docs.yml`.
The live documentation will be available at:
**https://nvlabs.github.io/GR00T-WholeBodyControl/**
## Documentation Structure
- `source/` - All documentation source files
- `conf.py` - Sphinx configuration
- `index.rst` - Main landing page
- `_static/` - Static assets (CSS, images, logos)
- `tutorials/` - Tutorial pages
- `getting_started/` - Getting started guides
- `user_guide/` - User guide
- `api/` - API reference
- `resources/` - Additional resources
## Writing Documentation
- Use Markdown (`.md`) or reStructuredText (`.rst`) files
- Markdown is recommended for simplicity
- Place new files in the appropriate subdirectory
- Update `index.rst` to add new sections to the navigation
## Theme
The documentation uses the `sphinx_book_theme` with NVIDIA branding, matching the Isaac Lab documentation style.
|