We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
This is part of the review feedback for JOSS submission (openjournals/joss-reviews#6024)
Currently the software does not have a documentation. The usage and instructions are in the readme file and there is no API reference doc.
It would be great if the developers can:
docs
Also, it would be great to provide a step-by-step guild on how to use the software in the documentation, along with necessary screenshots.
The text was updated successfully, but these errors were encountered:
Thank you for the great suggestion of using sphinx to generate an API and publish it in readthedoc.
We have done this (https://debyecalculator.readthedocs.io/en/latest/) while maintaining step-by-step use of 'DebyeCalculator' in the readme file of the project.
We have also added badges to the readme file of the pypi, python version, license, ChemRxiv file and readthedocs.
I will close this issue - let us know if it should be reopened.
Sorry, something went wrong.
FrederikLizakJohansen
No branches or pull requests
This is part of the review feedback for JOSS submission (openjournals/joss-reviews#6024)
Currently the software does not have a documentation. The usage and instructions are in the readme file and there is no API reference doc.
It would be great if the developers can:
docs
Also, it would be great to provide a step-by-step guild on how to use the software in the documentation, along with necessary screenshots.
The text was updated successfully, but these errors were encountered: