Package org.gradle.docs.guides

Interface Guides

All Known Implementing Classes:
GuidesInternal
public interface Guides

  • Method Details

    • getGuidesRoot

      org.gradle.api.file.DirectoryProperty getGuidesRoot()
      By convention, this is src/docs/guides
      Returns:
      The root guide directory.

    • getDistribution

      GuidesDistribution getDistribution()
      Returns:
      Buildable elements of all the available guides.

    • getPublishedGuides

      org.gradle.api.NamedDomainObjectContainer<? extends Guide> getPublishedGuides()
      Returns:
      Container of all published guides. This is the primary configuration point for all guides.