search

PrefectHQ / prefect-ray

Prefect integrations with Ray
https://prefecthq.github.io/prefect-ray/
Apache License 2.0
63 stars 5 forks source link

Configure mkdocs.yml to build API docs correctly #8

Closed tpdorsey closed 2 years ago

tpdorsey commented 2 years ago

Summary

Fixes mkdocs.yml configuration to build API pages correctly.

nav:
    - Home: index.md
    - Task Runners: task_runners.md

Note here that Home is built from README.md if a separate index.md does not exist.

Each subpage referenced here must refer to an .md file under /docs, which in turn references a source file containing the docstrings to be rendered:

::: prefect_ray.task_runners

Relevant Issue(s)

Checklist