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

Stingray plugin documentation generation with Adoc. #16

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

sketch34
Copy link

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.rb calls Stingray's make_docs.rb.

In the ./docs directory 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 ./docs dir.

You do not need to install the ixg-doc-tools to generate your plugin docs. Just define the %SR_SOURCE_DIR% environment variable (e.g. c:\dev\stingray) or modify the line in make_plugin_docs.rb. Then run the script and refer to the output directory in the console to view the generated documentation.

Usage:

ruby docs/make_plugin_docs.rb

@sketch34 sketch34 force-pushed the feature/plugin-adoc branch from 6a217ce to b9699e9 Compare November 23, 2017 03:14
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.

1 participant