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.

Sign up for GitHub

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

Jump to bottom

Publish documentation on readthedocs #37

Open

2 of 8 tasks

nicoddemus opened this issue Nov 20, 2017 · 0 comments

Assignees

Member

nicoddemus commented Nov 20, 2017 •

edited by prusse-martin

Loading

Extract documentation from docstrings and publish on readthedocs;
Add proper install and usage instructions;
Craft a minimal complete example of the usage;
Fix documentation build;
Check and update examples;
Investigate a better layout for the "reference" section;
Improve in auto generated documentation;
Extent example list with ... (we should list more advanced features and create a item for each one);

Suggestion for new items are welcome.

prusse-martin mentioned this issue

Inquiry on QmxGraph documentation #78

Closed

prusse-martin self-assigned this

prusse-martin mentioned this issue

Initial rtd #79

Merged

5 tasks

prusse-martin mentioned this issue

Change to src/ layout #102

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment