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 links to readme in documentation #64

Merged
merged 2 commits into from
Feb 15, 2024
Merged

Conversation

TeaganKing
Copy link
Collaborator

@TeaganKing TeaganKing commented Feb 15, 2024

Temporary fix for currently empty documentation

@TeaganKing TeaganKing requested a review from rmshkv February 15, 2024 00:15
@TeaganKing
Copy link
Collaborator Author

@rmshkv this addresses the currently empty installation instructions page that you noticed!

Copy link
Contributor

@rmshkv rmshkv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This works! I also tried directly inputting the readme file in index.rst (<../README.md>) but that didn't seem to work at first - we may want to play around with that more later

@TeaganKing
Copy link
Collaborator Author

This works! I also tried directly inputting the readme file in index.rst (<../README.md>) but that didn't seem to work at first - we may want to play around with that more later

Sounds good! I'll merge this now for a short-term solution, but it would be good to have the README fully linked there as you suggest so that we can update one and not have to update the other...

@TeaganKing TeaganKing merged commit a1790f9 into NCAR:main Feb 15, 2024
@TeaganKing
Copy link
Collaborator Author

(I am updating #38 to include Lev's suggestion)

@TeaganKing TeaganKing deleted the documentation branch April 1, 2024 20:47
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

Successfully merging this pull request may close these issues.

2 participants