mirror of
https://github.com/ZGCA-Forge/Elevator.git
synced 2026-02-05 13:55:14 +00:00
Add tests and docs
This commit is contained in:
61
docs/README.md
Normal file
61
docs/README.md
Normal file
@@ -0,0 +1,61 @@
|
||||
# Elevator Saga Documentation
|
||||
|
||||
This directory contains the Sphinx documentation for Elevator Saga.
|
||||
|
||||
## Building the Documentation
|
||||
|
||||
### Install Dependencies
|
||||
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
### Build HTML Documentation
|
||||
|
||||
```bash
|
||||
make html
|
||||
```
|
||||
|
||||
The generated HTML documentation will be in `_build/html/`.
|
||||
|
||||
### View Documentation
|
||||
|
||||
Open `_build/html/index.html` in your browser:
|
||||
|
||||
```bash
|
||||
# On Linux
|
||||
xdg-open _build/html/index.html
|
||||
|
||||
# On macOS
|
||||
open _build/html/index.html
|
||||
|
||||
# On Windows
|
||||
start _build/html/index.html
|
||||
```
|
||||
|
||||
### Other Build Formats
|
||||
|
||||
```bash
|
||||
make latexpdf # Build PDF documentation
|
||||
make epub # Build EPUB documentation
|
||||
make clean # Clean build directory
|
||||
```
|
||||
|
||||
## Documentation Structure
|
||||
|
||||
- `index.rst` - Main documentation index
|
||||
- `models.rst` - Data models documentation
|
||||
- `client.rst` - Client architecture and proxy models
|
||||
- `communication.rst` - HTTP communication protocol
|
||||
- `events.rst` - Event system and tick-based simulation
|
||||
- `api/modules.rst` - Auto-generated API reference
|
||||
|
||||
## Contributing
|
||||
|
||||
When adding new documentation:
|
||||
|
||||
1. Create `.rst` files for new topics
|
||||
2. Add them to the `toctree` in `index.rst`
|
||||
3. Follow reStructuredText syntax
|
||||
4. Build locally to verify formatting
|
||||
5. Submit PR with documentation changes
|
||||
Reference in New Issue
Block a user