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.

Sign up for GitHub

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

Jump to bottom

Feature/docs #26

Merged
merged 6 commits into from
Aug 22, 2020
Merged

Feature/docs #26

merged 6 commits into from
Aug 22, 2020

Conversation

justindujardin
Copy link
Owner

@justindujardin justindujardin commented Aug 22, 2020 •
edited
Loading

Update the project readme to include a project description and API/CLI documentation.

Changes:

  • Use typer-cli to generate docs for the CLI app
  • Use mathy_pydoc to generate docs for the Pathy APIs
  • Use githooks to auto-generate the docs when a code change happens

@justindujardin justindujardin marked this pull request as ready for review August 22, 2020 01:18
@justindujardin justindujardin merged commit b4364ec into master Aug 22, 2020
@justindujardin justindujardin deleted the feature/docs branch August 22, 2020 01:19
@justindujardin
Copy link
Owner Author

🎉 This PR is included in version 0.2.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@justindujardin