A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

addFilter(org.gradle.api.file.CopySpec) - Method in AntoraExtension.CopyFilter

Adds a filter to the copy specification based upon the tokens and the the delimiters

addTaskToAssembleDocsLifecycle(org.gradle.api.Project, java.lang.String) - Method in AntoraUtils

Adds the given task to the documentation assembly lifecycle task.

addTaskToPublishDocsLifecycle(org.gradle.api.Project, java.lang.String) - Method in AntoraUtils

Adds the given task to the documentation publication lifecycle task.

ANTORA_CONTENT_TAG_PREFIX - Field in AntoraPlugin

ANTORA_NODE_NAME - Field in AntoraNodeExtension

ANTORA_NPM_NAME - Field in AntoraNpmExtension

ANTORA_YML - Field in AntoraPlugin

AntoraBuildSiteTask - Class in org.ysb33r.ysf.projects.antora

Builds an Antora site.

AntoraBuildSiteTask() - Constructor in AntoraBuildSiteTask

AntoraExtension - Class in org.ysb33r.ysf.projects.antora

Configures Antora document generation.

AntoraExtension.CopyFilter - Class in org.ysb33r.ysf.projects.antora

Defines a copy filter.

AntoraExtension(org.gradle.api.Project) - Constructor in AntoraExtension

AntoraNodeExtension - Class in org.ysb33r.ysf.projects.antora

An extension to configure Node.js specific to Antora.

AntoraNodeExtension(org.gradle.api.Task) - Constructor in AntoraNodeExtension

AntoraNpmExtension - Class in org.ysb33r.ysf.projects.antora

An extension to configure Npm specific to Antora.

AntoraNpmExtension(org.gradle.api.Task) - Constructor in AntoraNpmExtension

AntoraNpmPackageInstall - Class in org.ysb33r.ysf.projects.antora

Install NPM packages specifically for Antora

AntoraNpmPackageInstall() - Constructor in AntoraNpmPackageInstall

AntoraPlaybookGeneratorTask - Class in org.ysb33r.ysf.projects.antora

Generates some files so that Antora documentation can be built.

AntoraPlaybookGeneratorTask() - Constructor in AntoraPlaybookGeneratorTask

AntoraPlugin - Class in org.ysb33r.ysf.projects.antora

Base plugin that is used for both local building and publishing

AntoraPlugin() - Constructor in AntoraPlugin

antoraSourceFilter - Property in AntoraExtension

A filter for copying unmodified Antora sources.

AntoraUtils - Class in org.ysb33r.ysf.projects.antora.internal

Utilities for dealing with various Antora operations.

AntoraUtils() - Constructor in AntoraUtils

antoraYmlFilter - Property in AntoraExtension

A filter for copying antora.yml

AntoraYmlUpdaterTask - Class in org.ysb33r.ysf.projects.antora

Reads a source Antora file and creates an intermediate antora file with updated NAV entries and Asciidoc attributes

AntoraYmlUpdaterTask() - Constructor in AntoraYmlUpdaterTask

API_DOCS_SECTION - Field in AntoraExtension

apply(org.gradle.api.Project) - Method in AntoraPlugin

ARTIFACT_ENTRIES - Field in AntoraPlugin

B

BUILD_TASK_NAME_LOCAL - Field in AntoraPlugin

BUILD_TASK_NAME_PUBLISH - Field in AntoraPlugin

BUILD_TASK_NAME_TEST - Field in AntoraPlugin

C

CHANGELOG_SECTION - Field in AntoraExtension

COMBINE_ALL_NAVS - Field in AntoraPlugin

configureCommonPlaybook(org.ysb33r.ysf.projects.antora.AntoraPlaybookGeneratorTask, java.util.Properties) - Method in AntoraUtils

Configures initial and common content for generating playbook related files.

createExecSpec() - Method in AntoraNodeExtension

Create execution specification.

D

E

entry - Property in EntryProvider

EntryProvider - Class in org.ysb33r.ysf.projects.antora.internal

Keeps a title and a reference for a line in a nav.adoc file.

EntryProvider() - Constructor in EntryProvider

exec() - Method in AntoraBuildSiteTask

exec() - Method in AntoraPlaybookGeneratorTask

exec() - Method in AntoraYmlUpdaterTask

exec() - Method in NavEntryFileGenerator

F

failOnWarnings - Property in AntoraBuildSiteTask

failureTrace - Property in GitlabTagExtension

A mechanism to display the stack trace on HTTP failures.

fetchContent - Property in AntoraBuildSiteTask

G

getAdditionalNavEntries() - Method in AntoraYmlUpdaterTask

getAntoraSourceDir() - Method in AntoraPlaybookGeneratorTask

getAntoraVersion() - Method in AntoraPlaybookGeneratorTask

getAsciidocAttributes() - Method in AntoraYmlUpdaterTask

getComponentName() - Method in AntoraExtension

The name of the Antora component.

getEndToken() - Method in AntoraExtension.CopyFilter

The terminating delimiter.

getEntriesFile() - Method in NavEntryFileGenerator

Where the updated nav.adoc for ROOT is written to.

getEnvironment() - Method in AntoraNpmPackageInstall

getGitlabProjectUri() - Method in AntoraPlaybookGeneratorTask

getHomeDirProvider() - Method in AntoraNpmPackageInstall

THe NPM home directory.

getIgnoreWarnings() - Method in AntoraExtension

Antora warnings to ignore.

getIncludedVersions() - Method in AntoraPlaybookGeneratorTask

getInputAntoraYml() - Method in AntoraYmlUpdaterTask

getKrokiVersion() - Method in AntoraPlaybookGeneratorTask

getLegacyDocumentationEntriesFile() - Method in NavEntryFileGenerator

getNavPropertyFiles() - Method in NavEntryFileGenerator

Files that define properties for various attachments.

getNodeExtension() - Method in AntoraNpmPackageInstall

getNodeJsExtensionName() - Method in AntoraNpmExtension

getNpmExecutor() - Method in AntoraNpmPackageInstall

getNpmExtension() - Method in AntoraNpmPackageInstall

getNpmPackageInstaller() - Method in AntoraNpmPackageInstall

getOutputAntoraYml() - Method in AntoraYmlUpdaterTask

getOutputDir() - Method in AntoraBuildSiteTask

Where to generate content into.

getOutputDirectory() - Method in AntoraPlaybookGeneratorTask

Location for writing the playbook to.

getPreservedLegacyVersions() - Method in AntoraExtension

Returns the list of legacy versions to be preserved.

getPreservedLegacyVersions() - Method in NavEntryFileGenerator

List of preserved legacy documentation versions

getPreserveLegacyDocumentation() - Method in AntoraExtension

Whether legacy documentation should be migrated if found.

getProjectArtifactsEntriesFile() - Method in NavEntryFileGenerator

Where there nav.adoc for API documentation is written to.

getRootStartDocument() - Method in AntoraExtension

The name of the document in ROOT/pages that shoudl be used as the starting point.

getSiteUrl() - Method in AntoraPlaybookGeneratorTask

Matches the Antora site_url.

getSourceDirectory() - Method in AntoraExtension

The directory where Antora sources are to be found.

getStartPageCoordinate() - Method in AntoraPlaybookGeneratorTask

getStartToken() - Method in AntoraExtension.CopyFilter

The starting delimiter.

getTitle() - Method in AntoraExtension

Documentation title for the project

getTitle() - Method in AntoraPlaybookGeneratorTask

getTokens() - Method in AntoraExtension.CopyFilter

Get the list of tokens to use for substitution.

getUiBundleArchive() - Method in AntoraPlaybookGeneratorTask

GitlabTagExtension - Class in org.ysb33r.ysf.projects.antora

An extension that is added to the gitPublishPush task.

GitlabTagExtension(org.gradle.api.Project) - Constructor in GitlabTagExtension

gitlabToken - Property in GitlabTagExtension

H

I

IGNORE_ARTIFACT_NAV - Field in AntoraPlugin

ignoreWarnings(java.lang.String) - Method in AntoraExtension

When considering Antora warnings as failures, ignore these warnings.

INSTALL_TASK - Field in AntoraPlugin

J

K

L

LEGACY_DOCS_ENTRIES - Field in AntoraPlugin

LEGACY_DOCS_SECTION - Field in AntoraExtension

M

N

NAME - Field in AntoraExtension

NAME - Field in GitlabTagExtension

NAV_ENTRIES_TASK - Field in AntoraPlugin

NAV_UPDATER_TASK - Field in AntoraPlugin

NavEntryFileGenerator - Class in org.ysb33r.ysf.projects.antora

Creates files that contains entries which can be appended to a nav.adoc file.

NavEntryFileGenerator() - Constructor in NavEntryFileGenerator

O

P

PLAYBOOK_TASK_NAME_LOCAL - Field in AntoraPlugin

PLAYBOOK_TASK_NAME_PUBLISH - Field in AntoraPlugin

PLAYBOOK_TASK_NAME_TEST - Field in AntoraPlugin

PREPROCESSOR_TASK - Field in AntoraPlugin

PROJECT_ARTIFACT_MODULE - Field in AntoraPlugin

projectIdentifier - Property in GitlabTagExtension

PUBLISH_TO_GIT_MAIN_SOURCESET - Field in AntoraPlugin

PUBLISH_TO_PAGES_KEY_PROPERTY - Field in AntoraPlugin

PUBLISH_TO_PAGES_SOURCESET - Field in AntoraPlugin

Q

R

readDisplayedVersions(java.io.File, Predicate<String>) - Method in AntoraUtils

Reads a file of displayed versions and returns the list of versions

ROOT_SUBPATH - Field in AntoraPlugin

S

setAdditionalNavEntries(Provider<List<String>>) - Method in AntoraYmlUpdaterTask

setAntoraSourceDir(java.lang.Object) - Method in AntoraPlaybookGeneratorTask

setAntoraVersion(java.lang.Object) - Method in AntoraPlaybookGeneratorTask

setAsciidocAttributes(Provider<Map<String, String>>) - Method in AntoraYmlUpdaterTask

setComponentName(java.lang.Object) - Method in AntoraExtension

Sets the component name.

setDisplayedVersionsFile(java.lang.Object) - Method in AntoraPlaybookGeneratorTask

setEntriesFile(java.lang.Object) - Method in NavEntryFileGenerator

setEnvironmentProvider(Provider<Map<String, String>>) - Method in AntoraBuildSiteTask

Provides additional environment variables.

setGitlabProjectUri(java.lang.Object) - Method in AntoraPlaybookGeneratorTask

setIgnoreWarnings(Provider<List<Pattern>>) - Method in AntoraBuildSiteTask

Sets a list of warnings to be ignored when failOnWarnings is true.

setInputAntoraYml(java.lang.Object) - Method in AntoraYmlUpdaterTask

setKrokiVersion(java.lang.Object) - Method in AntoraPlaybookGeneratorTask

setLegacyDocumentationEntriesFile(java.lang.Object) - Method in NavEntryFileGenerator

setLogFile(java.lang.Object) - Method in AntoraBuildSiteTask

Sets a log file.

setOutputDir(java.lang.Object) - Method in AntoraBuildSiteTask

Sets the destination directory

setOutputDirectory(java.lang.Object) - Method in AntoraPlaybookGeneratorTask

setPreservedLegacyVersions(Provider<List<String>>) - Method in NavEntryFileGenerator

setPreserveLegacyDocumentation(boolean) - Method in AntoraExtension

Sets whether legacy documentation should be preserved.

setProjectArtifactsEntriesFile(java.lang.Object) - Method in NavEntryFileGenerator

setRootStartDocument(java.lang.Object) - Method in AntoraExtension

Set the starting document.

setSiteUrl(java.lang.Object) - Method in AntoraPlaybookGeneratorTask

Set site URL.

setSourceDirectory(java.lang.Object) - Method in AntoraExtension

Set the Antora source directory.

setStartPageCoordinate(java.lang.Object) - Method in AntoraPlaybookGeneratorTask

setTitle(java.lang.Object) - Method in AntoraExtension

Sets the title of the project.

setTitle(java.lang.Object) - Method in AntoraPlaybookGeneratorTask

setUiBundleArchive(java.lang.Object) - Method in AntoraPlaybookGeneratorTask

SUBPATH_ANTORA_BUILD_LOCAL - Field in AntoraPlugin

Path in build directory into which the intermediate documentation containing HTML content will be written to.

SUBPATH_ANTORA_BUILD_PUBLISH - Field in AntoraPlugin

Path in build directory into which the final documentation containing HTML pages will be written to.

SUBPATH_ANTORA_BUILD_TEST - Field in AntoraPlugin

Path in build directory into which the current version's documentation is written to.

SUBPATH_ANTORA_LOGS - Field in AntoraPlugin

SUBPATH_ANTORA_NAV_ENTRIES - Field in AntoraPlugin

SUBPATH_ANTORA_PREPROCESSED - Field in AntoraPlugin

SUBPATH_ANTORA_WORKDIR_LOCAL - Field in AntoraPlugin

This is the directory to use when building locally only.

SUBPATH_ANTORA_WORKDIR_PUBLISH - Field in AntoraPlugin

This is the directory from which Antora will run in order to create HTML pages which can then be send to a tagged antora-pages branch.

SUBPATH_ANTORA_WORKDIR_TEST - Field in AntoraPlugin

This is the directory to use when testing this current version's documentation.

SUBPATH_DISPLAY_VERSIONS - Field in AntoraPlugin

SUBPATH_LEGACY_VERSIONS - Field in AntoraPlugin

SUBPATH_SUPPLEMENTAL_UI_FILES - Field in AntoraPlugin

T

tag(java.lang.String, java.lang.String, boolean) - Method in GitlabTagExtension

Create a tag.

title - Property in EntryProvider

tokens(Provider<Map<String, Object>>) - Method in AntoraExtension.CopyFilter

Adds providers to additional tokens.

U

V

VALIDATE_VERSIONS_TASK - Field in AntoraPlugin

VERSIONED_PAGES_BRANCH - Field in AntoraPlugin

W

X

Y

Z

_