Merged
Conversation
Merging changes from main
Collaborator
|
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! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Creating a readthedocs page: https://cloudcasting.readthedocs.io/