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

Rewrite README and fix various docstring issues #257

Merged
merged 5 commits into from
Nov 18, 2019

Conversation

djhoese
Copy link
Member

@djhoese djhoese commented Nov 17, 2019

This is a major overhaul of the documentation in the SIFT repository. I updated some of the wiki pages so they could be pointed to. Summary of changes:

  • Update README.md to point to Wiki
  • Add various web service badges to top of README (like travis ci, PyPI version, test coverage, etc)
  • Add README specifically for the Windows installer
  • Add contributor guide (updated related wiki page) and added it to the sphinx docs
  • Fix various sphinx related docstring issues (still some remaining)
  • Update API docs in sphinx

@djhoese djhoese self-assigned this Nov 17, 2019
@djhoese
Copy link
Member Author

djhoese commented Nov 18, 2019

The travis builds are failing on Windows because of a ci-helpers issue from what I can tell. I'll work on fixing that in a separate PR.

@djhoese djhoese merged commit 52800a1 into ssec:master Nov 18, 2019
@djhoese djhoese deleted the doc-readme branch November 18, 2019 01:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant