This directory contains documentation that describes Gradle's architecture and how the various pieces fit together and work.

## Architecture decision records (ADRs)

The Gradle team uses ADRs to record architectural decisions that the team has made.

See [Architecture decisions records](standards) for the list of ADRs.

from fastapi import FastAPI

app = FastAPI(docs_url="/documentation", redoc_url=None)


@app.get("/items/")
async def read_items():

////

## In der Dokumentation verwendete Begriffe { #terms-used-in-the-docs }

//// tab | Test

* Sie
* Ihr

* z. B.
* usw.

* `foo` vom Typ `int`
* `bar` vom Typ `str`
* `baz` vom Typ `list`

* das Tutorial – Benutzerhandbuch
* das Handbuch für fortgeschrittene Benutzer
* die SQLModel-Dokumentation
* die API-Dokumentation
* die automatische Dokumentation

package gradlebuild.docs;

import org.gradle.api.file.ConfigurableFileCollection;
import org.gradle.api.file.DirectoryProperty;

/**
 * Configuration for user manual documentation
 */
public abstract class UserManual {
    /**
     * The root of the user manual documentation.  This is the source of the adoc files.
     */
    public abstract DirectoryProperty getRoot();

    /**

            <option value="$PROJECT_DIR$/platforms/documentation/docs" />
            <option value="$PROJECT_DIR$/platforms/documentation/docs-asciidoctor-extensions" />
            <option value="$PROJECT_DIR$/platforms/documentation/docs-asciidoctor-extensions-base" />
            <option value="$PROJECT_DIR$/platforms/documentation/samples" />
            <option value="$PROJECT_DIR$/platforms/enterprise/enterprise" />

# OpenAPI `docs`

Utilities to handle OpenAPI automatic UI documentation, including Swagger UI (by default at `/docs`) and ReDoc (by default at `/redoc`).

::: fastapi.openapi.docs.get_swagger_ui_html

::: fastapi.openapi.docs.get_redoc_html

::: fastapi.openapi.docs.get_swagger_ui_oauth2_redirect_html

   * support for GWT serialization.
   *
   * @see <a href=
   *     "https://www.gwtproject.org/doc/latest/DevGuideServerCommunication#DevGuideSerializableTypes">
   *     Documentation about GWT serialization</a>
   */
  boolean serializable() default false;

  /**
   * When {@code true}, the annotated type is emulated in GWT. The emulated source (also known as

Even if they are in different modules (Python files).

///

## Exclude from OpenAPI { #exclude-from-openapi }

To exclude a *path operation* from the generated OpenAPI schema (and thus, from the automatic documentation systems), use the parameter `include_in_schema` and set it to `False`:

{* ../../docs_src/path_operation_advanced_configuration/tutorial003_py39.py hl[6] *}

import java.util.List;

import org.apache.commons.cli.Option;
import org.junit.jupiter.api.Test;

import static java.util.Objects.nonNull;

/**
 * Pseudo test to generate documentation fragment about supported CLI options. TODO such documentation generation code
 * should not be necessary as unit test but should be run during site generation (Velocity? Doxia macro?)
 */
@Deprecated
class CLIManagerDocumentationTest {

   * described in the class documentation.
   *
   * @throws NullPointerException if any of {@code elements} is null
   * @since 6.0
   */
  public static <E> ImmutableMultiset<E> copyOf(E[] elements) {
    return copyFromElements(elements);
  }

  /**
   * Returns an immutable multiset containing the given elements, in the "grouped iteration order"
   * described in the class documentation.
   *