Handsdown

Added
- Full support for Python 3.12 and Python 3.11
- Support for annotated assignments in classes and modules (🏆reported by nielstron in 30)

Changed
- `--exclude` CLI argument can override default excludes, add them manually (⚠️ **breaking change!**)
- Private and protected methods are included if they have a docstring (🏆reported by dvdblk in 31)
- Updated Docker image to Python 3.10.13 on Alpine Linux 3.19

Fixed
- Removed newlines in breadcrumbs

Fixed
- Rendered MD documents always end with a single newline (reported by arthurzenika in 27)

Notes

The rebirth of the lazy documentation generator. It is now faster, prettier, and lazier!

Highlights:
- Material design support
- `Jinja2` based rendering for templates with more flexibility
- Signatures are beautified with `black`
- Updated AST

Added
- CLI flag `--create-configs`
- Module `README.md` contains links to submodules
- New AST features support for Python 3.10 and 3.11

Changed
- `README.md` is no longer copied from the project, replaced with the former `MODULES.md`
- Instead of `MODULES.md` in the project root, documentation is copied from `HANDSDOWN.md`
- Signature output processed with `black`
- RtD and GitHub Pages configs are no longer created by default, use a CLI flag to update
- `Find in source` links now have filename and line

Fixed
- Document ToC respects duplicate headers
- Doctest blocks were not closed correctly (reported by djanderson in 24)
- Empty section blocks no longer create empty lines
- `.readthedocs.yml` now support a path to output directory other than `docs`
- Source code URL in output point to GitHub repository instead of `/blob/main/`

Notes

`--source-code-path` CLI parameter is no longer required as long as you store docs in the project folder. Paths to source code should be calculated automatically.

Added
- Related objects are extracted recursively from type annotations

Changed
- `--source-code-path` works as intended

Fixed
- Links in local docs were incorrect sometimes (reported by FredHappyface in 19)

Notes

Thank you for your feedback, Pull Requests, and bug reports! We have finally reached the first stable release. Expect better function signature formatting, new discovery for related resources and Pandas docstrings support in the future!

Feel free to request new features and report bugs. And stay warm!

Added
- `--source-code-path` CLI parameter

Fixed
- More informative CLI `--help` output
- Source code URLs are normalized

Added
- `-e` / `--encoding` CLI parameter to specify input/output file encoding, default `utf-8`
- Python 3.11 support

Changed
- Default input-output file encoding is `utf-8`
- Docker image rebased to `Python 3.10.2`

Removed
- Python 3.6 is no longer officially supported