Easier documentation, pre-commit updates, and more
Lots of new features and updates were incorporated in this release. Automatic documentation is now easier with support for building notebooks automatically. Mypy checking is now offered as part of continuous integration. If you don't need example code and tests you can exclude those from hydrated templates. Lots of usability improvements and bug fixes.
New Contributors
A huge thank you to all the new contributors!
- @jeremykubica made their first contribution in #76
- @dougbrn made their first contribution in #82
- @olivialynn made their first contribution in #99
- @smcguire-cmu made their first contribution in #89
What's Changed
- Remove jinja from smoke test file name. by @delucchi-cmu in #67
- Sphinx documentation skeleton by @delucchi-cmu in #70
- Add a pyproject to get readthedocs support. by @delucchi-cmu in #72
- More "practices" stubs. Fix doc bits of template. by @delucchi-cmu in #74
- Update README.md by @drewoldag in #75
- Add a makefile to the docs directory by @jeremykubica in #76
- Add pipx callout by @dougbrn in #82
- Give two options for project license by @delucchi-cmu in #81
- Renamed directory from
nbtonotebooksby @drewoldag in #83 - Updated setup-python version, added python version matrix. by @drewoldag in #80
- Remove extraneous stuff from README. by @delucchi-cmu in #84
- Document the setup questions by @jeremykubica in #85
- Use pretty LINCC logo for RTD by @delucchi-cmu in #86
- Add the license question to the documentation by @jeremykubica in #87
- Slight tweaks to the README and RTD docs. by @drewoldag in #92
- Consolidate on .yml file extension as much as possible by @drewoldag in #91
- Adding pre-commit hook to prevent committing large files by @drewoldag in #93
- Reorganize the docs folder by @jeremykubica in #101
- Add ability to have a simple install by @jeremykubica in #102
- Change single quotes to double quotes. by @jeremykubica in #103
- Fix broken link. by @delucchi-cmu in #104
- Adding notebook support by @olivialynn in #99
- added git-lfs instructions with question to help start using git-lfs … by @cchris28 in #100
- Always create bare module directories. by @delucchi-cmu in #105
- Updating docs and copier question by @drewoldag in #113
- Add repo badge by @dougbrn in #108
- Add MyPy static Type Checking by @smcguire-cmu in #89
- Remove extra vertical space by @drewoldag in #117
- Update smoke-test.yml by @drewoldag in #115
- Add .pylintrc configuration files for src and test directories by @smcguire-cmu in #118
- Fixing pre-commit failures for new projects. by @drewoldag in #120
- Added to the list of excluded dirs/files. by @drewoldag in #121
- Final changes for notebook support by @olivialynn in #125
- Adding documentation for pulling the template into existing projects. by @drewoldag in #124
Full Changelog: v1.2.1...v1.3.0