-
Notifications
You must be signed in to change notification settings - Fork 147
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
base: master
Are you sure you want to change the base?
Conversation
The |
|
After comparing the API section in I'll work on that next so that the API section is no longer necessary. |
There was a problem hiding this 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__
:
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.
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
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 setcopyright = '2019, Manraj Singh'
rather thancopyright = '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