## Docs

First, make sure you set up your environment as described above, that will install all the requirements.

### Docs live

During local development, there is a script that builds the site and checks for any changes, live-reloading:

<div class="termy">

```console
$ python ./scripts/docs.py live

<span style="color: green;">[INFO]</span> Serving on http://127.0.0.1:8008

  Set<N> nodes();

  /** Returns all edges in this network, in the order specified by {@link #edgeOrder()}. */
  Set<E> edges();

  /**
   * Returns a live view of this network as a {@link Graph}. The resulting {@link Graph} will have
   * an edge connecting node A to node B if this {@link Network} has an edge connecting A to B.
   *

    "name": "Foo",
    "description": "The pretender",
    "price": 42.0,
    "tax": 3.2,
    "tags": ["rock", "metal", "bar"],
    "image": {
        "url": "http://example.com/baz.jpg",
        "name": "The Foo live"
    }
}
```

Завдяки такій декларації у **FastAPI** Ви отримуєте:

* Підтримку в редакторі (автозавершення тощо), навіть для вкладених моделей
* Конвертацію даних
* Валідацію даних

    "name": "Foo",
    "description": "The pretender",
    "price": 42.0,
    "tax": 3.2,
    "tags": ["rock", "metal", "bar"],
    "image": {
        "url": "http://example.com/baz.jpg",
        "name": "The Foo live"
    }
}
```

Ещё раз: сделав такое объявление, с помощью **FastAPI** вы получите:

* Поддержку редакторов IDE (автодополнение и т.д), даже для вложенных моделей
* Преобразование данных

    /**
     * Set the authentication time-to-live in milliseconds
     *
     * @param ttl time-to-live in milliseconds (0 or negative for no expiration)
     */
    public void setAuthenticationTTL(long ttl) {
        this.authenticationTTL = ttl;
    }

    /**
     * Get the authentication time-to-live in milliseconds
     *
     * @return time-to-live in milliseconds
     */

    // wait, so that entries have just 10 ms to live
    ticker.advance(ttl * 2 / 3, MILLISECONDS);

    assertEquals(10, CacheTesting.expirationQueueSize(cache));
    assertEquals(0, removalListener.getCount());

    int shift2 = shift1 + 10;
    loader.setValuePrefix(shift2);
    // fill with new data - has to live for 20 ms more
    for (int i = 0; i < 10; i++) {

        // Referral flags (2 bytes)
        SMBUtil.writeInt2(0, buffer, 14);

        // Proximity (2 bytes for v3)
        SMBUtil.writeInt2(0, buffer, 16);

        // Time to live (2 bytes for v3)
        SMBUtil.writeInt2(300, buffer, 18);

        // DFS path offset (2 bytes) - points to string data
        SMBUtil.writeInt2(stringDataStart - 8, buffer, 20); // Offset from start of referral

                + (this.expiration - System.currentTimeMillis()) + "]";
    }

    /**
     * Get the time to live for this referral
     *
     * @return the ttl
     */
    public long getTtl() {
        return this.ttl;
    }

    /**
     * {@inheritDoc}
     *
     * @see java.lang.Object#hashCode()

   * An unmodifiable element-count pair for a multiset. The {@link Multiset#entrySet} method returns
   * a view of the multiset whose elements are of this class. A multiset implementation may return
   * Entry instances that are either live "read-through" views to the Multiset, or immutable
   * snapshots. Note that this type is unrelated to the similarly-named type {@code Map.Entry}.
   *
   * @since 2.0
   */
  interface Entry<E extends @Nullable Object> {

```

</div>

In the output, there's a line with something like:

```hl_lines="4"
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
```

That line shows the URL where your app is being served, in your local machine.

### Check it { #check-it }