{Issue #6}: Add sphinx docs

JoseALermaIII commented 5 years ago

Description of new feature, or changes

Initializes documentation using Sphinx. Supports both reStructuredText and markdown. Content is mainly from docstrings via autodoc and a rewrite of README.md to reStructuredText format. Also added FAQ page that includes mention of Windows compatible spinners. Specifically, that it defaults to line for now. Compatibility with other operating systems can be added as needed.

Checklist

[x] Your branch is up-to-date with the base branch
[x] You've included at least one test if this is a new feature
[x] All tests are passing

Related Issues and Discussions

Fixes #6 and finishes off #5.

Proofing may be needed to ensure all the desired information is present. For example, in docs/source/conf.py I set copyright = '2019, Manraj Singh' rather than copyright = '2019, Manraj Singh and contributors'.

Directions for building documentation included in DEVELOPMENT.md.

Documentation can be tested with tox -e sphinx.

People to notify

@manrajgrover

JoseALermaIII commented 5 years ago

The napoleon extension is needed because of the NumPy style docstrings. Edit: Sample website of latest commit can be found at halo.josealerma.com

JoseALermaIII commented 5 years ago

autodoc writes the API reference from the docstrings, so I didn't replicate the API section from README.md.

~~Docs seem sparse. Should CONTRIBUTING.md be added?~~

coveralls commented 5 years ago

Pull Request Test Coverage Report for Build 413

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-1.5%) to 89.563%

Totals
Change from base Build 409:	-1.5%
Covered Lines:	900
Relevant Lines:	990

💛 - Coveralls

JoseALermaIII commented 5 years ago

After comparing the API section in README.md, I'd like to replace the docstrings with it since it is much more detailed.

I'll work on that next so that the API section is no longer necessary.

manrajgrover / halo