dtourolle/pyWebLayout
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc updates
Some checks failed
Python CI / test (3.10) (push) Has been cancelled
Details
Python CI / test (3.12) (push) Has been cancelled
Details
Python CI / test (3.13) (push) Has been cancelled
Details

Browse Source
This commit is contained in:
Duncan Tourolle 2025-11-09 22:06:42 +01:00
parent cc34c79495
commit 40c1b913ec
3 changed files with 16 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -164,14 +164,24 @@ python 01_simple_page_rendering.py
python 08_pagination_demo.py # NEW: Multi-page documents python 08_pagination_demo.py # NEW: Multi-page documents
``` ```
**All new examples include comprehensive test coverage!** See [NEW_EXAMPLES_AND_TESTS_SUMMARY.md](docs/NEW_EXAMPLES_AND_TESTS_SUMMARY.md) for details. **All new examples include comprehensive test coverage!** Run tests with:
```bash
python -m pytest tests/examples/ -v # 30 tests, all passing ✅
```
**Coverage Impact:** The new examples fill critical documentation gaps:
- **PageBreak:** 0% → 100% (had NO examples before)
- **LinkText:** 14% → 100% (all 4 link types demonstrated)
- **FormFields:** 14% → 100% (all 14 field types demonstrated)
See **[examples/README.md](examples/README.md)** for detailed documentation. See **[examples/README.md](examples/README.md)** for detailed documentation.
## Documentation ## Documentation
- **[ARCHITECTURE.md](ARCHITECTURE.md)** - Detailed explanation of Abstract/Concrete architecture - **[ARCHITECTURE.md](ARCHITECTURE.md)** - Abstract/Concrete architecture guide
- **[examples/README.md](examples/README.md)** - Complete guide to all examples - **[examples/README.md](examples/README.md)** - Complete examples guide with tests
- **[docs/images/README.md](docs/images/README.md)** - Visual documentation index
- **[pyWebLayout/layout/README_EREADER_API.md](pyWebLayout/layout/README_EREADER_API.md)** - EbookReader API reference
- **API Reference** - See docstrings in source code - **API Reference** - See docstrings in source code
## License ## License

2
docs/images/README.md
View File

@ -192,7 +192,7 @@ All new examples (08, 09, 10) include:
- ✅ Visual output verification - ✅ Visual output verification
- ✅ Working code examples - ✅ Working code examples
See [NEW_EXAMPLES_AND_TESTS_SUMMARY.md](../NEW_EXAMPLES_AND_TESTS_SUMMARY.md) for detailed information. See the main [README.md](../../README.md) and [examples/README.md](../../examples/README.md) for detailed information.
--- ---

5
examples/README.md
View File

@ -230,10 +230,9 @@ python -m pytest tests/examples/test_10_forms_demo.py -v
## Additional Documentation ## Additional Documentation
- `README_HTML_MULTIPAGE.md` - HTML multi-page rendering guide - `README_HTML_MULTIPAGE.md` - HTML multi-page rendering guide
- `../docs/NEW_EXAMPLES_AND_TESTS_SUMMARY.md` - Detailed summary of new examples (08, 09, 10)
- `../ARCHITECTURE.md` - Detailed explanation of the Abstract/Concrete architecture - `../ARCHITECTURE.md` - Detailed explanation of the Abstract/Concrete architecture
- `../docs/images/` - Rendered example outputs - `../docs/images/README.md` - Visual documentation index with all examples
- `../docs/images/README.md` - Visual documentation index - `../pyWebLayout/layout/README_EREADER_API.md` - EbookReader API reference
## Debug/Development Scripts ## Debug/Development Scripts