https://github.com/dohsimpson/kubernetes-doc-pdf

Kubernetes PDF Documentation
https://github.com/dohsimpson/kubernetes-doc-pdf

Last synced: about 2 months ago
JSON representation

Kubernetes PDF Documentation

• Host: GitHub
• URL: https://github.com/dohsimpson/kubernetes-doc-pdf
• Owner: dohsimpson
• Created: 2018-06-24T11:39:31.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-05-25T00:00:17.000Z (7 months ago)
• Last Synced: 2024-08-02T17:35:16.055Z (5 months ago)
• Language: Python
• Homepage:
• Size: 159 MB
• Stars: 267
• Watchers: 18
• Forks: 165
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Kubernetes PDF Documentation

### This repository contains all the [Kubernetes documentation](https://kubernetes.io/docs/home/) 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](https://kubernetes.io/docs/home/#browsedocs)

## 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:

* EPUB/MOBI version of the documents can be found [here](https://github.com/tha2015/kubernetes-doc-epub)

* [Terraform PDF Documentation](https://github.com/dohsimpson/terraform-doc-pdf)