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

Preview documentation from pull requests #391

Closed
tkoyama010 opened this issue Jul 20, 2023 · 4 comments
Closed

Preview documentation from pull requests #391

tkoyama010 opened this issue Jul 20, 2023 · 4 comments
Assignees
Labels
new: documentation Highlight a new community raised "documentation" issue type: documentation Auto-labelled for doc/* and docs/* branches

Comments

@tkoyama010
Copy link
Collaborator

📚 Documentation

Our project can be configured to build and host documentation for every new pull request. Previewing changes during review makes it easier to catch formatting and display issues before they go live. This feature will be very useful for maintaining documentation in the future.
github-build-status-reporting

@tkoyama010 tkoyama010 added new: documentation Highlight a new community raised "documentation" issue type: documentation Auto-labelled for doc/* and docs/* branches labels Jul 20, 2023
@bjlittle
Copy link
Owner

bjlittle commented Jul 20, 2023

@tkoyama010 Thanks! Now that SciPy is over and the code base is relatively stablish, I'm keen to start banking the core documentation. It's well overdue.

I've figured out the structure of the docs that I'd like to follow, so in the coming weeks I'm going to start to lay down the foundations of the docs.

This is super useful, thanks 😀👍

@bjlittle bjlittle self-assigned this Jul 20, 2023
@tkoyama010
Copy link
Collaborator Author

@bjlittle
Great, I have a few things I'd like to try about creating API documentation, so please mention me when it is ready.

@bjlittle bjlittle moved this to 🆕 Candidate in 🦅 GeoVista v0.5.0 Nov 23, 2023
@bjlittle bjlittle moved this from 🆕 Candidate to 📚 Backlog in 🦅 GeoVista v0.5.0 Nov 23, 2023
@bjlittle bjlittle moved this from 📚 Backlog to 🔖 Assigned in 🦅 GeoVista v0.5.0 Nov 25, 2023
@bjlittle bjlittle moved this from 🔖 Assigned to 🚀 In Progress in 🦅 GeoVista v0.5.0 Dec 3, 2023
@bjlittle
Copy link
Owner

bjlittle commented Dec 3, 2023

@tkoyama010 I've enabled this now, see #550 as the first PR to auto-build the docs as part of CI 👍

Image

@bjlittle bjlittle moved this from 🚀 In Progress to 🏁 Done in 🦅 GeoVista v0.5.0 Dec 3, 2023
@bjlittle bjlittle closed this as completed Dec 3, 2023
@tkoyama010
Copy link
Collaborator Author

@bjlittle Awesome! Thanks for your work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new: documentation Highlight a new community raised "documentation" issue type: documentation Auto-labelled for doc/* and docs/* branches
Projects
Status: 🏁 Done
Development

No branches or pull requests

2 participants