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.

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

Build documentation in Sphinx #19

Closed
ns-rse opened this issue Nov 30, 2023 · 1 comment
Closed

Build documentation in Sphinx #19

ns-rse opened this issue Nov 30, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@ns-rse
Copy link
Collaborator

ns-rse commented Nov 30, 2023

Should include...

  • Overview
  • Supported File Formats
  • Usage
  • Contributing Guidelines
  • API
  • Multiple versions

Deploy either on GitHub Pages (in which case use sphinx multiversion) or ReadTheDocs.org in which case a unique .readthedocs.yaml is required and the account configuration should indicate which versions the documentation should be built for.
@ns-rse ns-rse added the documentation Improvements or additions to documentation label Nov 30, 2023
@ns-rse
Copy link
Collaborator Author

ns-rse commented Feb 3, 2025

Closing, plumped for mkdocs over Sphinx and merged with #103

The website is at https://afm-spm.github.io/AFMReader

@ns-rse ns-rse closed this as completed Feb 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ns-rse