3b84216652
* Document how to build the doumentation with sphinx
For convinience, I added a Makefile which spares one to memorize the
long sphinx command, or type python setup.py build_sphinx
You simply use `make html` and you will get the docs.
* Render README with markdown properly
conf.py includes some code to work around a bug in
common mark. The markdown is now properly converted to HTML.
* Fix rendering of CONTRIBUTING.md
27 lines
572 B
ReStructuredText
27 lines
572 B
ReStructuredText
.. kubernetes-python-client documentation master file, created by
|
|
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
Welcome to kubernetes-python-client's documentation!
|
|
========================================================
|
|
|
|
Contents:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
README <README.md>
|
|
installation
|
|
usage
|
|
modules
|
|
contributing <CONTRIBUTING.md>
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|
|
|