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

Make docs #223

Merged
merged 12 commits into from
Apr 10, 2024
Merged

Make docs #223

merged 12 commits into from
Apr 10, 2024

Conversation

jonhealy1
Copy link
Collaborator

@jonhealy1 jonhealy1 commented Apr 9, 2024 •
edited
Loading

Related Issue(s):

Description:

  • Adding mkdocs and pdocs for generating docs via running make docs.
  • GH workflow for automatically generating docs, publishing docs to stac-utils.github.io when pushing to main branch.
  • A lot of this was copied from the main stac-fastapi repo.
  • Re-organized documentation, added CONTRIBUTING.md etc.

PR Checklist:

  • Code is formatted and linted (run pre-commit run --all-files)
  • Tests pass (run make test)
  • Documentation has been updated to reflect changes, if applicable
  • Changes are added to the changelog

@jonhealy1 jonhealy1 marked this pull request as ready for review April 10, 2024 04:38
jamesfisher-gis
jamesfisher-gis approved these changes Apr 10, 2024
View reviewed changes
Copy link
Collaborator

@jamesfisher-gis jamesfisher-gis left a comment

Choose a reason for hiding this comment

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

Nice. Would this be a good time to create a new release?

@jonhealy1 jonhealy1 merged commit 8d017dd into main Apr 10, 2024
4 checks passed
@jonhealy1 jonhealy1 mentioned this pull request Apr 14, 2024
Open
@jonhealy1 jonhealy1 deleted the makedocs branch May 9, 2024 06:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@StijnCaerts StijnCaerts StijnCaerts approved these changes

@vincentsarago vincentsarago vincentsarago approved these changes

@jamesfisher-gis jamesfisher-gis jamesfisher-gis approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@jonhealy1 @StijnCaerts @vincentsarago @jamesfisher-gis