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

Update documentation #65

Merged
merged 4 commits into from
Oct 19, 2019
Merged

Update documentation #65

merged 4 commits into from
Oct 19, 2019

Conversation

jbouter
Copy link
Member

@jbouter jbouter commented Oct 19, 2019

  • Rewrite readme into markdown

Closes #64

Signed-off-by: Jeffrey Bouter jb@warpnet.nl

- Rewrite readme into markdown

Closes #64

Signed-off-by: Jeffrey Bouter <jb@warpnet.nl>
@roaldnefs
Copy link
Member

The CI pipeline breaks because the README.rst is used by the setup.py file. To allow the setup.py file to read Markdown and display it on PyPi we need to follow the instructions on: https://packaging.python.org/guides/making-a-pypi-friendly-readme/.

jbouter and others added 3 commits October 19, 2019 15:20
- Read from README.md instead of rst

Signed-off-by: Jeffrey Bouter <jb@warpnet.nl>
- Inform setup.py the README is markdown

Signed-off-by: Jeffrey Bouter <jb@warpnet.nl>
Fix indentation in README.md and remove links at the bottom.
@roaldnefs roaldnefs added the Type: Enhancement New feature or request label Oct 19, 2019
@roaldnefs roaldnefs merged commit 4f7521d into develop Oct 19, 2019
@roaldnefs roaldnefs deleted the update-docs branch October 21, 2019 18:23
@roaldnefs roaldnefs mentioned this pull request Oct 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants