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 docs badge in readme.md #39

Open
pbranson opened this issue Sep 22, 2023 · 5 comments
Open

Update docs badge in readme.md #39

pbranson opened this issue Sep 22, 2023 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@pbranson
Copy link
Member

Once final docs location is established update the badge and pull down the old docs.

@pbranson pbranson added the documentation Improvements or additions to documentation label Sep 22, 2023
@rafa-guedes
Copy link
Collaborator

Is there any preference between hosting it with readthedocs vs github pages? If the preference is readthedocs then we could migrate the existing build @tomdurrant has setup with github pages to replace the old docs on readthedocs. If we are happy with using github pages than we could simply change the badge and bring the old one down.

(between, I have added the latest github pages docs to the description of the rompy repository)

@hot007 hot007 mentioned this issue Mar 5, 2024
@pbranson
Copy link
Member Author

pbranson commented Mar 5, 2024

Happy to go with github pages

@tomdurrant
Copy link
Collaborator

I'm not fussed. Keeping it in github seems like the easiest option unless there is a compelling reason for rtd. Lets include this as part of #75

@tomdurrant tomdurrant added this to the wp3 milestone Mar 12, 2024
@rafa-guedes
Copy link
Collaborator

Sounds good to me. If we are all happy to keep the Github Pages one, could you please switch off the RTD one once you have the chance @pbranson?

@rafa-guedes
Copy link
Collaborator

BTW I have replaced the badge in README.md of the boundspec branch to point to the Github Pages version (this branch is probably ready to be merged).

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