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

Break Gradle Plugin into multiple plugins and add support for other documentation tool runners #30

Closed
2 of 6 tasks
cjbrooks12 opened this issue Jan 8, 2018 · 1 comment
Labels
build tools Project Type: Build tools, Gradle plugins, etc. enhancement Task Type: New features, additional options for existing features, etc.

Comments

@cjbrooks12
Copy link
Contributor

cjbrooks12 commented Jan 8, 2018

Gradle plugins (in buildSrc) should include:

  • The core plugin to run Orchid from command line
  • Plugin to run Orchid from Javadoc
  • Additional plugins for other purposes, such as Dokka (Kotlin), Scaladoc, etc. Integrating Orchid with those tools should have an accompanying Orchid Plugin which implements the same or similar functionality as the Gradle tool it is replacing, but embedded within Orchid.

Each plugin should be distributed as its own plugin on the Gradle Plugins Portal. All "additional" plugins should either require the core plugin or have the core plugin bundled with it.

Also, add Gradle plugin to run Orchid from Kotlin's "Javadoc" Dokka. May need to reach out to the Dokka team to find the simplest way to integrate Dokka and Orchid, hopefully without re-inventing their build tool.

Subtasks

  • Move Javadoc to separate plugin
  • Create Dokka plugin (even if it just replaces the Dokka task without generating code docs at the moment)
  • Create Android-based Orchid plugin (rather than java-based)
  • Create Android-based Javadoc plugin (rather than java-based)
  • Create Maven Orchid plugin
  • Create Maven Javadoc plugin
@cjbrooks12 cjbrooks12 changed the title Break Gradle Plugin into multiple plugins: the core plugin to run Orchid from command line, and plugin to run Orchid from Javadoc Break Gradle Plugin into multiple plugins Jan 9, 2018
@cjbrooks12 cjbrooks12 added enhancement Task Type: New features, additional options for existing features, etc. build tools Project Type: Build tools, Gradle plugins, etc. labels Jan 10, 2018
@cjbrooks12 cjbrooks12 changed the title Break Gradle Plugin into multiple plugins Break Gradle Plugin into multiple plugins and add support for other documentation tool runners Mar 5, 2018
@cjbrooks12
Copy link
Contributor Author

cjbrooks12 commented Aug 2, 2018

After enough frustration with running Orchid as a Doclet, I updated the Orchid Javadoc plugin to get the Javadoc model directly rather than going through the official javadoc CLI to start Orchid. This means we no longer need a dedicated gradle plugin to use Javadoc in Orchid.

Updated checklist:

  • Create Dokka Orchid plugin. I have gotten it working by manipulating the output from the Gradle task (see here), but want to have it load the documentation model from within Orchid and not need the Gradle plugin at all. I'm currently inquiring about the possibility of running Dokka from an Orchid generator, see Does Dokka support custom generators/doclets? Kotlin/dokka#344
  • Create Android-based Orchid plugin (rather than java-based)
  • Create Maven Orchid plugin
  • Have the bundle projects also produce a fat-jar Capsule, so Orchid can be easily run directly as a CLI tool, but i want them to load additional jars relative to the capsule so that additional plugins can be dropped into a folder and discovered automatically
  • Create a simple kscript and host it as a Gist, so that Orchid can be easily run and customized with a script, without needing Gradle

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build tools Project Type: Build tools, Gradle plugins, etc. enhancement Task Type: New features, additional options for existing features, etc.
Projects
None yet
Development

No branches or pull requests

1 participant