fix: issues (1)
This commit is contained in:
29
README.md
29
README.md
@@ -373,26 +373,31 @@ CREATE TABLE IF NOT EXISTS user_preferences (
|
||||
2. Convert: `pyside6-uic dialog.ui -o dialog_ui.py`
|
||||
3. Create dialog class in `src/ui/dialogs/`
|
||||
4. Connect signals to business logic
|
||||
### Building Documentation
|
||||
|
||||
```bash
|
||||
# Using uv
|
||||
uv run mkdocs build
|
||||
uv run mkdocs serve # View at http://localhost:8000
|
||||
## 📚 Documentation
|
||||
|
||||
# Or with activated venv
|
||||
mkdocs build
|
||||
mkdocs serve
|
||||
```*[API Documentation](docs/)**: Detailed module documentation
|
||||
- **[User Manual](docs/index.md)**: Complete user guide (MkDocs)
|
||||
- **[User Manual](docs/)**: Complete user guide built with Zola and the Tanuki theme
|
||||
- View documentation at `http://localhost:8000` when running the application
|
||||
|
||||
### Building Documentation
|
||||
|
||||
The documentation is built using [Zola](https://www.getzola.org/) with the Tanuki theme.
|
||||
|
||||
```bash
|
||||
mkdocs build
|
||||
mkdocs serve # View at http://localhost:8000
|
||||
# Build documentation using the provided script
|
||||
.\build_docs.ps1
|
||||
|
||||
# Or manually:
|
||||
cd docs
|
||||
zola build
|
||||
|
||||
# Serve documentation locally for development
|
||||
cd docs
|
||||
zola serve # View at http://127.0.0.1:1111
|
||||
```
|
||||
|
||||
The built documentation is served automatically when you run the application and access the documentation menu.
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
Contributions are welcome! Please follow these guidelines:
|
||||
|
||||
Reference in New Issue
Block a user