Add sphinx and contribution guide to documentation#64
Add sphinx and contribution guide to documentation#64petarnikolovski wants to merge 6 commits intopylti:masterfrom
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 19Continue to review full report at Codecov.
|
ryanhiebert
left a comment
There was a problem hiding this comment.
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. |
docs/contributing.rst
Outdated
| .. code-block:: sh | ||
|
|
||
| cd lti | ||
| python setyp.py bdist_wheel |
|
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 thencdintodocsand usemake html.index.htmlwill be located in the_builddirectory.