-
Notifications
You must be signed in to change notification settings - Fork 46
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
Add sphinx and contribution guide to documentation #64
base: master
Are you sure you want to change the base?
Conversation
Codecov Report
@@ Coverage Diff @@
## master #64 +/- ##
=======================================
Coverage 85.88% 85.88%
=======================================
Files 16 16
Lines 659 659
Branches 115 115
=======================================
Hits 566 566
Misses 74 74
Partials 19 19 Continue to review full report at Codecov.
|
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.
Looks good, thank you for putting in the work to make this happen. Just a couple small errors that I'm sure you'll want to clean up before we merge it.
docs/contributing.rst
Outdated
Setup development environment | ||
----------------------------- | ||
|
||
If you decide to contribute to code base, you'll first have to fork the project on GitHub, and then clone the project in the local environment. You'll need a GitHub account in order to make a fork. |
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.
To the code base
docs/contributing.rst
Outdated
.. code-block:: sh | ||
|
||
cd lti | ||
python setyp.py bdist_wheel |
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.
setup.py
Thanks for taking time to review. I'll make changes later, and I'll also change few commands in the contribution instruction guide to match changes when Pipfile is added to the project. |
I've fixed the typo and the missing article. However, I haven't yet updated the contribution process. I'll do that when I finally setup Pipfile (I have some problems with |
Hi. I've added basic documentation with Sphinx. So far, introduction is mostly copied from README to sphinx docs. The novelty here is a short contribution guide which covers:
If you want to see the documentation,
pip install sphinx
, and thencd
intodocs
and usemake html
.index.html
will be located in the_build
directory.