cloudkitty/doc/source/index.rst
Luka Peschke b7e8323f63 Add support for PDF doc generation
This adds support for pdf documentation generation. Work items:

* Provide a distinct index for pdf doc. This is required as the toctree in a
  tab fails to render as a pdf document.

* Remove the v2 API reference from the pdf documentation. "rest_expand_all",
  "rest_method" and "rest_parameters" are not supported.

* Add a pdf-docs tox env

* Update conf.py

Story: 2006075
Task: 34808
Change-Id: I848d59b551fe6d5077960dc45554c7281c2372a7
2019-09-16 15:42:55 +02:00

43 lines
780 B
ReStructuredText

======================================
Welcome to CloudKitty's documentation!
======================================
..
NOTE: This is the index for the rst version only. If you update this file
please update pdf-index.rst accordingly
.. include:: common-index.rst
Documentation contents
======================
.. list-table::
:header-rows: 1
* - Documentation type
- Table of contents
* - **End User**
- .. toctree::
:maxdepth: 3
user/index
* - **Admin / Operator**
- .. toctree::
:maxdepth: 2
admin/index
* - **Developer**
- .. toctree::
:maxdepth: 2
developer/index
* - **API Reference**
- .. toctree::
:maxdepth: 2
api-reference/index