Package org.gradle.docs.guides.internal

Class GuidesInternal

java.lang.Object
org.gradle.docs.guides.internal.GuidesInternal
All Implemented Interfaces:
Guides
public abstract class GuidesInternal extends Object implements Guides

  • Constructor Details

    • GuidesInternal

      @Inject public GuidesInternal(org.gradle.api.model.ObjectFactory objectFactory)

  • Method Details

    • getPublishedGuides

      public org.gradle.api.NamedDomainObjectContainer<? extends GuideInternal> getPublishedGuides()
      Specified by:
      getPublishedGuides in interface Guides
      Returns:
      Container of all published guides. This is the primary configuration point for all guides.

    • getBinaries

      public org.gradle.api.DomainObjectSet<? super GuideBinary> getBinaries()

    • getDistribution

      public GuidesDistribution getDistribution()
      Specified by:
      getDistribution in interface Guides
      Returns:
      Buildable elements of all the available guides.

    • getDocumentationInstallRoot

      public abstract org.gradle.api.file.DirectoryProperty getDocumentationInstallRoot()
      By convention, this is buildDir/working/guides/docs
      Returns:
      The root directory for all documentation.

    • getRenderedDocumentationRoot

      public abstract org.gradle.api.file.DirectoryProperty getRenderedDocumentationRoot()
      By convention, this is buildDir/working/guides/render-samples
      Returns:
      The root directory for rendered documentation.