This is the code repository for Charmed Kubeflow (CKF) documentation. See CKF official documentation for the rendered documentation.

CKF documentation is based on Canonical's Sphinx starter pack. See its documentation for more details on how to build and customize it, run automatic checks, and explore other available configurations.

Run the following command within the docs folder to build the documentation locally:

   make run

Run various checks locally with the following commands.

Check links:

   make linkcheck

Check spelling:

   make spelling

Check inclusive language:

   make woke

Check accessibility:

   make pa11y