Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc configuration update #49

Merged
merged 11 commits into from
Jun 1, 2021
Merged

Doc configuration update #49

merged 11 commits into from
Jun 1, 2021

Conversation

aburrell
Copy link
Member

Updates to address #48 including

  • PEP8 updates to conf
  • Switching from pytest-flake8 to flake8
  • Fixing docstring style violations found by sphinx
  • Cycled Python version testing support
  • Updated README in preparation for the next release
  • Fixed the zenodo author name style.

Updated the order of the first and last names in the .zenodo.json creators list.
Updated the document configuration by:
- adding common variables to reduce duplication,
- fixing PEP8 style violations,
- linking the authors to the zenodo.json file, and
- adding a logo display to the docs sidebar.
Fixed docstring style violations flagged by sphinx.
Updated the README to reflect the conditions of the next release.
Cycled the supported python versions and removed the pytest-flake8 options.
Switched linter from pytest-flake8 to flake8.
Cycled the supported python versions and removed the pytest-flake8 call, replacing it with flake8.
Updated the CHANGELOG with the changes made on this branch.
README.md Outdated Show resolved Hide resolved
Fixed the full-path image link to point to the correct repository.
setup.cfg Outdated Show resolved Hide resolved
Added a newline to end of setup.cfg.
@aburrell aburrell requested a review from jklenzing May 26, 2021 12:57
@aburrell aburrell added this to the 0.0.4 Release milestone May 26, 2021
@aburrell aburrell linked an issue May 26, 2021 that may be closed by this pull request
4 tasks
Copy link
Member

@jklenzing jklenzing left a comment

Choose a reason for hiding this comment

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

minor update to keep the flake8 linting at the same level

.travis.yml Outdated Show resolved Hide resolved
Updated the flake8 testing command, since flake8 will error on warnings by default.

Co-authored-by: Jeff Klenzing <jklenzing@gmail.com>
@aburrell aburrell merged commit 1a9def6 into develop Jun 1, 2021
@aburrell aburrell deleted the conf_update branch June 1, 2021 19:35
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.

STY: Update standards in conf.py
2 participants