From 7777943a031505a1d474321a0ad372d643070f8e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Thu, 23 May 2019 14:20:33 +0200 Subject: [PATCH] doc: add a page with examples. --- doc/python/conf.py | 5 ++++- doc/python/pages/index.rst | 3 ++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/python/conf.py b/doc/python/conf.py index 27dec18..f9db31f 100644 --- a/doc/python/conf.py +++ b/doc/python/conf.py @@ -47,7 +47,9 @@ INPUT_MODULES = [corrade, magnum] INPUT_PAGES = [ 'pages/index.rst', 'pages/building.rst', - 'pages/api-conventions.rst' + 'pages/api-conventions.rst', + + '../../../magnum-examples/doc/python/examples.rst' ] INPUT_DOCS = [ 'corrade.containers.rst', @@ -70,6 +72,7 @@ PLUGINS = [ 'm.dox', 'm.gh', 'm.htmlsanity', + 'm.images', 'm.link', 'm.math', 'm.sphinx' diff --git a/doc/python/pages/index.rst b/doc/python/pages/index.rst index e8a54cd..07d3a0a 100644 --- a/doc/python/pages/index.rst +++ b/doc/python/pages/index.rst @@ -45,7 +45,8 @@ details. See the :link-ref:`building docs ` for an installation guide, :link-ref:`API convention documentation ` and :link-ref:`documentation of each module ` for more information -about the actual usage. +about the actual usage. There are also :link-ref:`examples ` to +give you an idea about how the API feels. `Contact & support`_ ====================