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 documentation #167

Merged
merged 9 commits into from
May 24, 2024
Merged

Update documentation #167

merged 9 commits into from
May 24, 2024

Conversation

wigging
Copy link
Collaborator

@wigging wigging commented May 22, 2024

This adds several pages to the documentation and cleans up some of the content. Installation, Usage, and Contributing pages are added. An Examples section has also been added along with a page that discusses the ImageMagick file example. Sphinx dependencies are added to the conda environment file.

@wigging wigging requested a review from tskluzac May 22, 2024 17:46
@wigging
Copy link
Collaborator Author

wigging commented May 24, 2024

@tskluzac I added some commands in the contributing document regarding building/viewing the documentation. Let me know if any more minor changes are needed; otherwise, this is good to merge.

Copy link
Collaborator

@tskluzac tskluzac left a comment

Choose a reason for hiding this comment

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

Great start! Thanks for putting this one together. I'll be happy to add some to this next week.

@tskluzac tskluzac merged commit 4d28db3 into main May 24, 2024
1 check passed
@tskluzac tskluzac deleted the update-docs branch May 24, 2024 20:34
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.

2 participants