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

Add documentation #1

Open
2 of 3 tasks
rguliev opened this issue Oct 2, 2023 · 0 comments
Open
2 of 3 tasks

Add documentation #1

rguliev opened this issue Oct 2, 2023 · 0 comments
Assignees

Comments

@rguliev
Copy link
Collaborator

rguliev commented Oct 2, 2023

  • Add auto doc generation using mkdocs + mkgendocs + mkdocs-material (a good example can be found in this repo)
  • Add a general introduction with the context of the repository
  • Add specific subsections (see hyperSpec docs for an example):
    • creating, filtering, combining, and changing the data
    • arithmetic operations
    • working with wavelenghts (interpolation and other)
    • aggregation and applying function
    • baseline correction
    • normalization
    • spike removal
    • plotting
@rguliev rguliev self-assigned this Aug 26, 2024
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

1 participant