Skip to content

History

History

v1.3.3

*#31 Use peotry to create test environment when running tox

v1.3.2

#28 Send notification mail whenever build success or failed #27 failed to send build notfication mail due to no from field

v1.3.1

*#26 use mike to deploy multiple version of documentation directly, removed github action peaceiris/actions-gh-pages@v3

v1.3

  • #23 add email notification upon build success
  • #24 config repo secrets by script
  • #25 support create repo and upload source code

v1.2.2

  • #22 mike deploy failed

v1.2.1

  • #21 add environment variable: repo_name and repon_owner

v1.2

  • #7 documentatioin will now support multiple versions
  • #8 add .docstring.tpl to project
  • #10 fixed.
  • #11 fixed.
  • #12 replaced.
  • #13 implemented. Only tested with vscode, please have autodocstrings extension installed.
  • #14 implemented.
  • #15 done.
  • #16 fixed
  • #18 fixed
  • #19 implemented.
  • #20 implemented. You can refer by using ${{ env.package_version_short }} and ${{ env.package_version_full }} now.

v1.0

first release with the following features:

  1. Poetry: Manage version, dependancy, build and release
  2. Mkdocs: Writting your docs in markdown style
  3. Testing with Pytest (unittest is still supported out of the box)
  4. Code coverage report and endorsed by Codecov
  5. Tox: Test your code against environment matrix, lint and artifact check.
  6. Format with Black and Isort
  7. Lint code with Flake8 and Flake8-docstrings
  8. Pre-commit hooks: Formatting/linting anytime when commit/run local tox/CI
  9. Mkdocstrings: Auto API doc generation
  10. Command line interface using Python Fire (optional)
  11. Continuouse Integration/Deployment by github actions, includes:
    • publish dev build/official release to TestPyPI/PyPI automatically when CI success
    • publish documents automatically when CI success
    • extract change log from github and integrate with release notes automatically
  12. Host your documentation from Git Pages with zero-config