Issue 36 readme refactor

[heycatwonton]

Adds changelog to README and Sphinx documentation. Adds contributing to README, edits install instructions. Adds copyright and license to documentation. Renames api.rst and models.rst files. Changes basin3d-core to basin3d reference in documentation. Changes setup.py. Moves items around in table of contents.

Closes #36. References and closes #35, #20

Type of change

Please delete options that are not relevant.

• This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

• Unit tests
• Integration tests
• Test coverage >= 90%
• Flake8 Tests
• Mypy Tests
• Other - manual review - docs successfully generated

Test Configuration

• Python Version: 3.7

PR Self Evaluation

strikethrough things that don’t make sense for your PR

• ~My code follows the agreed upon best practices`
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests or modified existing tests that prove my fix is effective or that my feature works
• Existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in the appropriate modules
• I have performed a self-review of my own code

[vchendrix]

@heycatwonton You have two commits only one has an issue number in it. Also, did you mean to have two separate commits? It is unclear what is different about the second one. Are there not two differet Issues you are addressing?

[vchendrix]

Fix the comments as described in my comment

[heycatwonton]

@vchendrix The first commit was the first draft and was incomplete, and the 2nd commit was the completion of it. Because of that, they are not 2 different issues being addressed since.

I wanted to squash the 2 commits which it looks like I was able to do, but then 2 previous commits (Documentation: Contact Us and changes relative urls...) were also committed along with it - they are both old commits from a previous branch. I am not sure why this happened. How can I remove those 2 commit that are not supposed to be there?

[vchendrix]

@vchendrix The first commit was the first draft and was incomplete, and the 2nd commit was the completion of it. Because of that, they are not 2 different issues being addressed since.

I wanted to squash the 2 commits which it looks like I was able to do, but then 2 previous commits (Documentation: Contact Us and changes relative urls...) were also committed along with it - they are both old commits from a previous branch. I am not sure why this happened. How can I remove those 2 commit that are not supposed to be there?

@heycatwonton it is hard for me to say why those commits are there. When squashing you can choose to remove the commits completely by deleting the lines on rebase

[heycatwonton]

@vchendrix I did git rebase -i HEAD~2, which showed me the last 2 commits, both for this branch. I picked the 1st one and squashed the 2nd one. I edited the commit msg and then git push -f.

[heycatwonton]

@vchendrix I was able to fix this with the help with Danielle! The local branch was not synced with latest release, in this branch I did a git rebase release and a git push -f. I needed to close and reference #20 and #30 as well, so I went back to edit the commit msg with git commit --amend and did another git push -f. Hopefully those are the correct steps, let me know if it is or isn't.

[dschristianson]

One specific change requested in setup.py.

One issue for which I can't figure out the source. I could successfully generate the documentation. On the main page, when I click "Key Functions", I am taken to the old api page and the breadcrumbs in the upper left of the doc goes back to "basin3d-core 0.0.1 > api". Perhaps a "core" reference is still lingering somewhere??

[dschristianson]

Add the actual authors and their emails here.

[heycatwonton]

I will make those changes and look for where that 'basin3d-core 0.0.1' could be

[heycatwonton]

@dschristianson which page(s) did you open where you see basin3d-core 0.0.1?

[dschristianson]

takes me here