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

Update Cookiecutter template via Cruft, minor docstring modifications #212

Merged
merged 11 commits into from
Jun 16, 2023

Conversation

Zeitsperre
Copy link
Contributor

@Zeitsperre Zeitsperre commented Jun 13, 2023

Pull Request Checklist:

  • This PR addresses an already opened issue (for bug fixes / features)
    • This PR fixes #xyz
  • (If applicable) Documentation has been added / updated (for bug fixes / features).
  • (If applicable) Tests have been added.
  • This PR does not seem to break the templates.
  • HISTORY.rst has been updated (with summary of main changes).
    • Link to issue (:issue:number) and pull request (:pull:number) has been added.

What kind of change does this PR introduce?

  • Updates the cookiecutter based on the latest changes in the recipe
  • Added sphinx_codeautolink and sphinx_copybutton

Does this PR introduce a breaking change?

Some workflows have changed to reflect new packaging methods. Not really.

Other information:

@Zeitsperre Zeitsperre added documentation Improvements or additions to documentation CI Modifications to autiomation utilities labels Jun 13, 2023
@Zeitsperre Zeitsperre self-assigned this Jun 13, 2023
Copy link
Collaborator

@aulemahal aulemahal left a comment

Choose a reason for hiding this comment

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

That's good cookie making.

@Zeitsperre
Copy link
Contributor Author

There's one final bug to address:

    long_description=readme + "\n\n" + history,

We can't add the history to the package metadata if it contains the sphinx directives. I'll fix this issue tomorrow upstream.

@Zeitsperre Zeitsperre merged commit 90539f2 into main Jun 16, 2023
@Zeitsperre Zeitsperre deleted the cruft_update branch June 16, 2023 15:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Modifications to autiomation utilities documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants