Stingray plugin documentation generation with Adoc.#16
Open
sketch34 wants to merge 2 commits intoAutodeskGames:developfrom
Open
Stingray plugin documentation generation with Adoc.#16sketch34 wants to merge 2 commits intoAutodeskGames:developfrom
sketch34 wants to merge 2 commits intoAutodeskGames:developfrom
Conversation
Removing gameware urls.
6a217ce to
b9699e9
Compare
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.
Note: This currently requires Stingray source access due to the dependency on Adoc which resides in the Stingray repo. Perhaps Adoc could in the future be separated into a public submodule to address this.
make_plugin_docs.rbcalls Stingray'smake_docs.rb.In the
./docsdirectory there's a ruby script that will generate documentation for your plugin using Adoc. Refer to the comments in the script and the other documentation example files in the./docsdir.You do not need to install the
ixg-doc-toolsto generate your plugin docs. Just define the%SR_SOURCE_DIR%environment variable (e.g.c:\dev\stingray) or modify the line inmake_plugin_docs.rb. Then run the script and refer to the output directory in the console to view the generated documentation.Usage: