UserGuideTransformTask.groovy

Clone Tools
  • last updated a few seconds ago
Constraints
Constraints: committers
 
Constraints: files
Constraints: dates
Combine and rewrite all documentation generation

  1. … 276 more files in changeset.
Enable code quality tasks for buildSrc

Previously, when we changed buildSrc to multi-project, the code quality tasks are disabled

accidentally because the plugin was applied to buildSrc root project. This PR fixes the issue

and several code style issues.

  1. … 4 more files in changeset.
Convert user manual to be generated by Asciidoctor only

This change replaces all embedded Docbook syntax from the user manual.

Asciidoctor files are now converted directly to HTML and PDF.

It not only greatly simplifies the user manual generation pipeline, but also it makes it faster.

I did the following for all user manual pages:

- [x] Adjusted links to other manual pages, DSL docs, and Javadocs where necessary.

Fixed a couple dozen broken links at least.

- [x] Convert samples XML from docbook to asciidoctor syntax

- [x] Converted wide tables to a more flexible list-based display

Important contributor differences from now on:

- Users must use a `<file>.adoc#` prefix for all cross-reference links.

This is _required_ to achieve working links in all 3 outputs: multi-page user manual, single-page user manual, and PDF.

- The manual PDF is no longer themed, and no longer has the list of examples links in the TOC.

- File names were changed from camelCased to snake_case to have a crystal clear 1-1 mapping between source to output.

- Section reference verification is now handled by Asciidoctor verbose mode.

- The single-page user manual has the same navigation as the multi-page manual for now.

- [Common Asciidoctor extensions](https://github.com/gradle/dotorg-docs/tree/master/docs-asciidoctor-extensions) are now used by Gradle Guides and the User Manual, however, the the web assets (CSS, JS, etc) are not yet merged.

These extensions are responsible for injecting the navigation and styles.

The header/footer/navigation HTML can now be found under `subprojects/docs/src/main/resources`.

  1. … 401 more files in changeset.
Externalize samples testing infrastructure

This change replaces UserGuideSamplesRunner with an external library

called sample-check. Sample discovery, execution, and normalization

is delegated to this library, with some custom normalizers remaining

in the Gradle codebase.

Samples output has become co-located with the sample code. Samples tests

must be run with Java 8+.

  1. … 782 more files in changeset.
Take away Gradle-specific highlighting in docs

  1. … 2 more files in changeset.
Allow Groovy, Kotlin, and Gradle-specific syntax highlighting

This change creates and uses custom xslthl config that allows

Docbook to highlight syntax in a language specific way instead of

just always falling back to java.

Styles for syntax highlighting are adjusted to match IntelliJ

defaults

  1. … 9 more files in changeset.
Refactored buildSrc into modules to improve feedback cycles

- Created module boundaries around different languages and slow tests

    • -0
    • +288
    ./UserGuideTransformTask.groovy
  1. … 528 more files in changeset.