Skip to content

dohsimpson/kubernetes-doc-pdf

Repository files navigation

Kubernetes PDF Documentation

This repository contains all the Kubernetes documentation in PDF format, generated automatically.

How the files are structured?

PDF files can be found under PDFs directory; they are grouped in sections:

  • Setup (Getting Started)
  • Concepts
  • Tasks
  • Tutorials
  • Reference
  • kubectl Reference

For a more detailed index, see here

Dependencies

  • docker
  • python3
    • pipenv
    • requests-html

How to run the code

  1. Install the dependencies. Use $ pipenv install for installing python packages.
  2. $ pipenv shell
  3. $ python kubernetes-doc.py
  4. $ ./gen_ref_docs.sh

Troubleshooting

  • If weasyprint is stuck when generating pages, check if you run out of memory, generating the larger PDFs (e.g. Reference.pdf) is quite memory heavy.

Similar Project: