NVIDIA Cloud Native Technologies Documentation

This is the documentation repository for software under the NVIDIA Cloud Native Technologies umbrella. The tools allow users to build and run GPU accelerated containers with popular container runtimes such as Docker and orchestration platforms such as Kubernetes.

The product documentation portal can be found at: https://docs.nvidia.com/datacenter/cloud-native/index.html

Building Documentation

Use the Dockerfile in the repository (under the docker directory) to generate the custom doc build container. The Dockerfile is based off the official spinhxdoc container and includes some customizations (e.g. the sphinx-copybutton).

docker build --pull \
    --tag cnt-doc-builder \
    --file docker/Dockerfile .

The docs can then be built using the custom doc build container cnt-doc-builder from the previous step:

docker run -it --rm \
    -v <path-to-local-workspace>/cnt-docs:/docs \
    cnt-doc-builder \
    make html

The resulting HTML pages are located in the _build/html sub-directory of your <path-to-local-workspace>/cnt-docs directory.

Additionally, the Gitlab CI for this project is configured to build and stage the documentation on every commit pushed to Gitlab. The staged documentation should be available to view via Gitlab Pages for your repository. To find the pages url, visit Settings > Pages from the Gitlab UI. The url can also be found at the bottom of the logs for the build_docs stage of the CI.

License and Contributing

This documentation repository is licensed under Apache 2.0.

Contributions are welcome. Refer to the CONTRIBUTING.md document for more information on guidelines to follow before contributions can be accepted.