diff options
| author |   Michal Cmarada <mcmarada@cisco.com> | 2019-03-11 13:29:57 +0100 |
|---|---|---|
| committer | Michal Cmarada <mcmarada@cisco.com> | 2019-03-15 10:07:11 +0100 |
| commit | a9aacd4d48c3a5887267366c2ef643e953975792 (patch) | |
| tree | c90c7c41eb77f8679cbcd85d66e7dde0067570ab /docs/index.rst | |
| parent | f8e326876496ddcdaaa2525596c30aad820b69f4 (diff) | |
add documentation generator
Enables generating of HTML documentation. It depends on sphinx generator.
During configuration if sphinx is detected it will generate "docs" target
for make. To build the documentation use "make docs", which will build
the HTML documentation in build-root/html.
Change-Id: Ia627f7d26c954a2341e13a54006955d21d162802
Signed-off-by: Michal Cmarada <mcmarada@cisco.com>
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..6609e9c --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,19 @@ +.. JVPP documentation master file, created by + sphinx-quickstart on Mon Mar 11 12:39:44 2019. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to JVPP's documentation! +================================ + +.. toctree:: + :maxdepth: 2 + + jvpp + docs + + +Indices and tables +================== + +* :ref:`search` |