Update docs

[gwaybio]

Description

Updating to furo sphinx theme, adding README parsing, and some documentation cleanup in preparation for version 1 release.

will cause merge conflict with #289 (both update README)

What is the nature of your change?

• Bug fix (fixes an issue).
• Enhancement (adds functionality).
• Breaking change (fix or feature that would cause existing functionality to not work as expected).
• This change requires a documentation update.

Checklist

Please ensure that all boxes are checked before indicating that a pull request is ready for review.

• I have read the CONTRIBUTING.md guidelines.
• My code follows the style guidelines of this project.
• I have performed a self-review of my own code.
• 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.
• New and existing unit tests pass locally with my changes.
• I have added tests that prove my fix is effective or that my feature works.
• I have deleted all non-relevant text in this pull request template.

[codecov-commenter]

Codecov Report

Merging #290 (6062cae) into master (921dcfe) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #290   +/-   ##
=======================================
  Coverage   95.12%   95.12%           
=======================================
  Files          57       57           
  Lines        3057     3057           
=======================================
  Hits         2908     2908           
  Misses        149      149           

Flag	Coverage Δ
unittests	95.12% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[d33bs]

Nice work! The furo theme looks great - really neat to see the updates here and I'm excited for these changes. Please let me know if you have any questions or concerns about the comments in the review.

Alongside the comments, I also had the following thoughts:

• Would make sense to outline the documentation build and deployment process and expectations somewhere (maybe in contributing.md docs?).
• When I ran sphinx-build ... -W I noticed there was a warning which might be a quick fix that could be added alongside these changes: docstring of pycytominer.normalize.normalize:64:Unexpected indentation..

[gwaybio]

Thanks @d33bs !

Would make sense to outline the documentation build and deployment process and expectations somewhere (maybe in contributing.md docs?).

This is a great idea. I added a note in f94bbfb - please suggest changes if you can think to add anything else. Thanks!

When I ran sphinx-build ... -W I noticed there was a warning which might be a quick fix that could be added alongside these changes: docstring of pycytominer.normalize.normalize:64:Unexpected indentation..

Hmm, I am not seeing these warnings...

[d33bs]

Looks good! Thank you for addressing the comments. I left a couple additional minor comments, please let me know if you have any questions.