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

Update documentation #38

Closed
TeaganKing opened this issue Jan 9, 2024 · 5 comments
Closed

Update documentation #38

TeaganKing opened this issue Jan 9, 2024 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@TeaganKing
Copy link
Collaborator

Some documentation currently lives here: https://nbscuid.readthedocs.io/en/latest/

It'd be great to update this to reflect newer code structure.

@TeaganKing TeaganKing added the documentation Improvements or additions to documentation label Jan 9, 2024
@TeaganKing
Copy link
Collaborator Author

The documentation currently lives here: https://ncar.github.io/CUPiD/index.html

We should also figure out how to directly add the readme file to index.rst (rather than just include hyperlink), as @rmshkv suggested!

@anissa111
Copy link
Member

The documentation currently lives here: ncar.github.io/CUPiD/index.html

We should also figure out how to directly add the readme file to index.rst (rather than just include hyperlink), as @rmshkv suggested!

I can take this on!

@TeaganKing
Copy link
Collaborator Author

The documentation for setting up a new notebook that is compatible with CUPiD is now complete, and the readme is now on our documentation page, as well, as mentioned in comments above.

The next item to do would be to focus on including specific function documentation with sphinx and readthedocs.

@TeaganKing
Copy link
Collaborator Author

Additionally, we should add an 'adding scripts' page to the documentation

@mnlevy1981
Copy link
Collaborator

Replaced with #73 and #74

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants