Skip to content

Conversation

@sverhoeven
Copy link
Member

@sverhoeven sverhoeven commented May 4, 2021

Random bits to make template & package developer experience better.

Added

  • Template unit tests for documentation generation, linting and version bumping
  • Docstring for function
  • Coverage and doctest commands for documentation #97

Changed

  • Initial linting is error free #227
  • Consolidated test/lint/build/docs into single matrix workflow #270
  • Enforce isort configuration
  • Default for package_short_description in cookiecutter questionnaire
  • Link checker ignores GH private pages and test pypi site #288
  • In CI build workflow make prospector die if there are errors #275
  • All example tests make use of example function
  • Use bumpversion for version in Sphinx config #44
  • Regenerated docs/conf.py with sphinx-quickstart v3.5.4 + enabled built-in extensions #44
  • Generate api rst files with extension instead of custom function #95

Removed

  • .pylintrc file, was too strict, too soon #267
  • Unused development dependencies #167
  • Statements in project_setup.md already mentioned in README.dev.md

Tested with https://github.com/sverhoeven/justatest2, where workflows are build workflow is green and https://justatest2.readthedocs.io/en/latest/autoapi/justatest2/my_module/index.html works.

@sverhoeven sverhoeven marked this pull request as ready for review May 4, 2021 07:17
@sverhoeven sverhoeven changed the title Kitchen sink Random bits May 4, 2021
Co-authored-by: Faruk D. <fdiblen@users.noreply.github.com>
Copy link
Member

@fdiblen fdiblen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing contribution. Thank you @sverhoeven 🎖️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants