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

[JOSS review] Add documentation and publish it #14

Closed
KedoKudo opened this issue Nov 28, 2023 · 1 comment
Closed

[JOSS review] Add documentation and publish it #14

KedoKudo opened this issue Nov 28, 2023 · 1 comment
Assignees

Comments

@KedoKudo
Copy link

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:

  • add a documentation folder like docs
  • use sphinx or other software to help generate the API doc
  • publish the doc on readthedoc or on GitHub page.

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.

@AndySAnker
Copy link
Collaborator

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.
Screenshot 2024-01-17 at 11 36 43

I will close this issue - let us know if it should be reopened.

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

No branches or pull requests

3 participants