Build API doc for all Camera types and functions #2112
Merged
Conversation
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
* Add modules to update_quick_index.py * Add generated file to doc/api_docs/arcade.rst toctree
* Fix build error due to syntax issue in alignment * Add cross-refs * General touch-ups for style and phrasing
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.
TL;DR: Expose all Camera types and functions in the API doc
Changes
TL;DR: Get all camera API doc building by applying the debugging clarity provided by #2109
advanced_cameras.rstfileAttributes:since Sphinx really doesn't like it with our plugin configWhy?
TL;DR: Part of a 3.0 Mandatory ticket (#1853)
If we have a new camera system, it needs to be documented. This is another step in that.
Future Work