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

Initial rtd #79

Merged
merged 4 commits into from
Mar 11, 2020
Merged

Initial rtd #79

merged 4 commits into from
Mar 11, 2020

Conversation

prusse-martin
Copy link
Member

@prusse-martin prusse-martin commented Mar 6, 2020

  • Extract documentation from docstrings and publish on readthedocs;
  • Add proper install and usage instructions;
  • Craft a minimal complete example of the usage;
  • Improve in auto generated documentation;
  • Extent example list with ... (we should list more advanced features and create a item for each one);


or
https://prusse-qmxgraph-fork.readthedocs.io/en/initial-rtd/index.html

This intent to handle #37.

@coveralls
Copy link

coveralls commented Mar 6, 2020

Coverage Status

Coverage remained the same at ?% when pulling ea985d1 on prusse-martin:initial-rtd into 7acfa58 on ESSS:master.

@nicoddemus
Copy link
Member

The build is failing currently:https://readthedocs.org/projects/qmxgraph/builds/10549792/

@nicoddemus
Copy link
Member

Also can you please add a task to tasks.py to generate the documentation locally?

@prusse-martin
Copy link
Member Author

I can add a task.
The build you linked is the official qmxgraph one, I am build the one from my fork here https://readthedocs.org/projects/prusse-qmxgraph-fork/builds/ the link in the initial description will point to the most recently build.

@prusse-martin
Copy link
Member Author

I will let the 2 remaining items for posterior work.

@haensch-mauricio
Copy link

This is great, very good job.

Copy link
Member

@nicoddemus nicoddemus left a comment

Choose a reason for hiding this comment

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

Great work!

@prusse-martin prusse-martin merged commit b865275 into ESSS:master Mar 11, 2020
@prusse-martin prusse-martin deleted the initial-rtd branch March 11, 2020 15:47
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.

4 participants