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

Add sphinx and contribution guide to documentation #64

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

Conversation

petarnikolovski
Copy link
Member

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:

  • How to fork/clone project
  • Install dependencies
  • General work-flow with git

If you want to see the documentation, pip install sphinx, and then cd into docs and use make html. index.html will be located in the _build directory.

@codecov
Copy link

codecov bot commented Jul 22, 2018

Codecov Report

Merging #64 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4cfe69e...0eb257b. Read the comment docs.

Copy link
Member

@ryanhiebert ryanhiebert left a 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.

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.
Copy link
Member

Choose a reason for hiding this comment

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

To the code base

.. code-block:: sh

cd lti
python setyp.py bdist_wheel
Copy link
Member

Choose a reason for hiding this comment

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

setup.py

@petarnikolovski
Copy link
Member Author

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.

@petarnikolovski
Copy link
Member Author

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 tox as I've described on issue #65).

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.

2 participants