Skip to content

Building documentation#88

Merged
phinate merged 18 commits intomainfrom
documentation
Apr 1, 2025
Merged

Building documentation#88
phinate merged 18 commits intomainfrom
documentation

Conversation

@IFenton
Copy link
Collaborator

@IFenton IFenton commented Jan 28, 2025

Creating a readthedocs page: https://cloudcasting.readthedocs.io/

@IFenton IFenton marked this pull request as draft January 28, 2025 12:08
@IFenton IFenton changed the title First pass at building documentation Building documentation Jan 29, 2025
@IFenton IFenton requested review from dfulu and phinate January 31, 2025 16:05
@IFenton IFenton marked this pull request as ready for review January 31, 2025 16:05
Copy link
Member

@jemrobinson jemrobinson left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Collaborator

@dfulu dfulu left a comment

Choose a reason for hiding this comment

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

Looks good to me too

@phinate
Copy link
Collaborator

phinate commented Feb 18, 2025

These look great, really nice job! :)

I just had one suggested change, which is just an organisational preference. Documentation like this collapses all of the API descriptions into a sub-heading, which could be a bit easier to parse (separating out API docs from examples and tutorials). This is the link to their implementation -- I think it's just a case of making a new file and linking it correctly to the index page.

I'm more than happy with the current docs though, so if you want to merge this and then make the change in a follow-up PR, I would just do that. Will leave that as your call!

@phinate phinate merged commit 9a6c188 into main Apr 1, 2025
7 checks passed
@phinate phinate deleted the documentation branch April 1, 2025 10:29
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.

4 participants