Skip to content

Latest commit

 

History

History
102 lines (71 loc) · 2.99 KB

CHANGELOG.rst

File metadata and controls

102 lines (71 loc) · 2.99 KB
Raw

Changelog

Future releases

.. todo::

    * Add GitHub Actions for testing MacOS and Windows platform builds
    * Improve template README.rst placeholder instructions
    * Create a ``gh-pages`` script to automate docs publishing steps

v0.3.1 (2020-07-23)

  • Add GitHub actions build test to project
  • Add logfunc exception handling to prevent errors when decorated function contains no docstring
  • Fix jinja variables in Travis badge and GitHub URLs to prevent error when distribution_name and repo_name differ
  • Fix template tox.ini to include src in flake8 linting test

v0.3.0 (2020-06-29)

  • Add tox to project repo for testing with py36, py37, py38
  • Refactor testing for clearer organization of default template vs. options tests
  • Add tox option to template choice variables
  • Add pre- and post-gen hooks for template rendering
  • Modify cookiecutter.json options to better reflect available rendering options
  • Make Travis-CI optional for the rendered template build process
  • Update documentation to reflect changes to the project and add developer notes

v0.2.1 (2020-06-17)

  • Add setup.py packaging and setuptools-scm versioning to project
  • Add unit tests and TravisCI to project

v0.2.0 (2020-06-14)

  • Add standard submodule placeholders to cc-pydata template
  • Add basic logging config and functionality to template
  • Add logging documentation to cc-pydata tutorial
  • Add sphinx.ext.autosummary api starter documentation to template docs

v0.1.7 (2020-05-31)

  • Add requirements and links to other useful resources to README.rst
  • Add basic Sphinx usage instructions to docs
  • Add basic unit testing info to docs

v0.1.6 (2020-05-26)

  • Fix gh-pages tutorial instructions
  • Fix template setup.cfg --pyargs to prevent travis-ci build failure

v0.1.5 (2020-01-13)

  • Add GitHub Pages git workflow to the project tutorial
  • Fix setuptools-scm and static path in the template conf.py file

v0.1.4 (2020-01-11)

  • Add notebooks directory to template
  • Add template directory structure to the project documentation

v0.1.3 (2020-01-10)

  • Add initial template README.rst to the template
  • Add Sphinx and flake8 to template Pipfile
  • Add Sphinx documentation skeleton with Jinja fields to template
  • Add initial content to the project tutorial

v0.1.2 (2020-01-06)

  • Add initial Sphinx documentation skeleton to project

v0.1.1 (2020-01-04)

  • Simplify packaging and remove tox.ini and MANIFEST.in from template
  • Add travis.yml, .editorconfig, and Pipfile to template
  • Add initial readme to project

v0.1.0 (2020-01-02)

  • Add basic python packaging files to template

v0.0.0 (2020-01-01)

  • Initial template with placeholder directories