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

{Issue #6}: Add sphinx docs #123

Open
wants to merge 35 commits into
base: master
Choose a base branch
from

Conversation

JoseALermaIII
Copy link

@JoseALermaIII JoseALermaIII commented Apr 16, 2019

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

  • Your branch is up-to-date with the base branch
  • You've included at least one test if this is a new feature
  • 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

@manrajgrover manrajgrover self-requested a review April 18, 2019 21:05
@JoseALermaIII
Copy link
Author

JoseALermaIII commented Apr 20, 2019

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
Copy link
Author

JoseALermaIII commented Apr 20, 2019

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?

@JoseALermaIII JoseALermaIII marked this pull request as ready for review April 20, 2019 07:58
@coveralls
Copy link

coveralls commented Apr 20, 2019

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 Coverage Status
Change from base Build 409: -1.5%
Covered Lines: 900
Relevant Lines: 990

💛 - Coveralls

@JoseALermaIII
Copy link
Author

JoseALermaIII commented Apr 21, 2019

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.

Copy link
Author

@JoseALermaIII JoseALermaIII left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It will be challenging to update the version information in two places, so here are a few ways to single-source the package version.

For simplicity, I usually put it in the module's __init__.py, like __author__ and __email__ are, as __version__:

halo/halo/__init__.py

Lines 1 to 3 in f76b256

# -*- coding: utf-8 -*-
__author__ = 'Manraj Singh'
__email__ = '[email protected]'

Not sure what the best practice is, but I'm willing to try them out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation on character support for the spinner
2 participants