Publishing code documentation in Kubernetes

Python’s Docstring, Java’s Javadoc, Go’s godoc. They are all designed to help people understand code.

When you compile code with one of the above tools, there is the option to output HTML documentation. HTML makes it easy to traverse in the browser, but these pages need to be hosted somewhere. There’s a few options available which include using GitHub Pages, publishing to a CDN, or running your own web server. If the documentation is part of a private repo (and therefore should remain only accessible within your organization), these options become a little bit more challenging to implement.

And so below we are going to describe how to setup the infrastructure

git-sync does most of the work for us. To quote the README of the project:

Click here to read.


Related articles

About travel audience

We provide integrated data-driven solutions for travel advertising and connect destinations and travel brands with potential travelers at scale.
Learn more