Add install instructions to docs

nreinicke commented 2 years ago

Fills out the install section of the docs and updates the README to link to this updated section (rather than duplicating the information).

nreinicke commented 2 years ago

Closes #56

Rowlando13 commented 2 years ago

I would have implemented this PR differently:

On the README, I would only have the build from the source instructions and link to documentation for full install instructions. We expect some people to have trouble with Pip, so I don't think we should lead with that. Once we get the package on Conda, then we can replace build from the source with conda install instructions.
In the install docs, I would lead with build from source, then conda (with a note about it being forthcoming), then pip with the warnings. Build from the source first since it is most likely to work since it is really just a conda install. Then conda and pip since they both have problems. One being that we have not implemented it yet and the other being tough dependency installs for windows.
I would have used #. for the numbering in lists since it autonumbers.

That being said, I am interested in your thoughts.

nreinicke commented 2 years ago

@Rowlando13 - this is good feedback. Ultimately I would like the package to be easy to install via pip and so we could just lead with that but we're not quite there yet. I've revised the README to just link directly to the docs and I've led with installation from source. Let me know what you think.

Rowlando13 commented 2 years ago

I meant to say this before, it is really nice to have another person work on documentation. So, thanks! I looked at the changes. A finer point about restructured text, you used ^^^^^ for breaking the sections, but the python style guide says to use -----------. Sphinx does not actually care. As you noticed, it generated valid sections. I think we should standardize now to make it easier for future contribution.

nreinicke commented 2 years ago

@Rowlando13 @machallboyd - thanks for the review!

@Rowlando13 - I like the idea of standardizing the documentation format and so I went ahead and updated that in b0a112f4148e9dab383848c19f9cf437e9cdc5f0

NREL / mappymatch

Add install instructions to docs #124