Skip to content

Commit c766528

Browse files
committed
fix: remove docs
1 parent 19f8c92 commit c766528

1 file changed

Lines changed: 0 additions & 43 deletions

File tree

README.md

Lines changed: 0 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -262,49 +262,6 @@ python train.py config/dummy.yaml use_amp=true amp_dtype="bf16"
262262
python train.py config/dummy.yaml use_compile=true compile_backend="inductor"
263263
```
264264

265-
## Documentation
266-
267-
This project includes comprehensive documentation built with MkDocs:
268-
269-
### Features
270-
271-
- **Auto-generated API Reference**: Automatically generated from docstrings and type hints
272-
- **Architecture Guides**: Detailed explanations of the registry system and configuration management
273-
- **Live Reloading**: Documentation automatically updates when you modify code or docs
274-
275-
### Viewing Documentation
276-
277-
```bash
278-
# Start the documentation server
279-
./script/run_docs.sh
280-
# Open your browser to http://127.0.0.1:8000
281-
```
282-
283-
The documentation server automatically watches for changes in:
284-
285-
- `doc/docs/` - Documentation markdown files
286-
- `mkdocs.yml` - Documentation configuration
287-
288-
### Building Documentation
289-
290-
```bash
291-
# Build static documentation
292-
uv run mkdocs build
293-
294-
# Documentation will be generated in doc/site/
295-
```
296-
297-
### Documentation Structure
298-
299-
- **[Home](doc/docs/index.md)**: Project overview and quick start
300-
- **[Architecture](doc/docs/architecture/)**: Core concepts and design patterns
301-
- Registry system explained
302-
- Configuration management
303-
- Component architecture
304-
- **[API Reference](doc/docs/api/)**: Auto-generated API documentation
305-
- All modules, classes, and functions
306-
- Type information and docstrings
307-
308265
## Architecture
309266

310267
### Project Structure

0 commit comments

Comments
 (0)