Skip to content

JOSS Review suggestion: integrate documentation in the GitHub page #3

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
Open
wbaccinelli opened this issue Mar 10, 2025 · 1 comment
Open

JOSS Review suggestion: integrate documentation in the GitHub page #3

wbaccinelli opened this issue Mar 10, 2025 · 1 comment

Comments

@wbaccinelli
Copy link

While the package documentation is available in the repository, it would be good to integrate it in the Documentation section of the existing GitHub page, to make it easier to consult for the users.
I also suggest to automatize the documentation generation process using tools such as MkDocs or Sphinx to increase the maintainability.
@wbaccinelli wbaccinelli mentioned this issue Mar 10, 2025
Open
@faroit
Copy link

faroit commented Mar 10, 2025

cross-referencing the review issue to keep track of the status openjournals/joss-reviews#7696

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@faroit @wbaccinelli