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

Proper documentation #18

Closed
AngryMaciek opened this issue Dec 26, 2020 · 5 comments · Fixed by #26
Closed

Proper documentation #18

AngryMaciek opened this issue Dec 26, 2020 · 5 comments · Fixed by #26
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@AngryMaciek
Copy link
Owner

Move the docs into GH Pages or ReadTheDocs, change md to rst; use sphinx; add CI and README shield, add proper code comments.

@AngryMaciek AngryMaciek added the documentation Improvements or additions to documentation label Dec 26, 2020
@AngryMaciek AngryMaciek self-assigned this Dec 26, 2020
@AngryMaciek
Copy link
Owner Author

After the documentation is built and we have an URL: add a link to PyPI and conda pages.

@AngryMaciek
Copy link
Owner Author

This might be a good place to start:
https://tech.michaelaltfield.net/2020/07/18/sphinx-rtd-github-pages-1/

@AngryMaciek
Copy link
Owner Author

AngryMaciek commented Apr 5, 2021

  • Finish this issue with 1.0.39, publish new version to Zenodo too? clean the CHANGELOG! Update project's homepage in other resources too!
  • binder: pkg version update!
  • clean gh pages branch!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant