From fe1a28f8d2b06915c053e7c2d4bb08effdaf1533 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Al=C3=A1n=20Mu=C3=B1oz?= <amuoz@ed.ac.uk> Date: Wed, 25 May 2022 14:30:52 +0100 Subject: [PATCH] add api.rst --- docs/source/api.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 docs/source/api.rst diff --git a/docs/source/api.rst b/docs/source/api.rst new file mode 100644 index 00000000..9edf4439 --- /dev/null +++ b/docs/source/api.rst @@ -0,0 +1,12 @@ +.. + DO NOT DELETE THIS FILE! It contains the all-important `.. autosummary::` directive with `:recursive:` option, without + which API documentation wouldn't get extracted from docstrings by the `sphinx.ext.autosummary` engine. It is hidden + (not declared in any toctree) to remove an unnecessary intermediate page; index.rst instead points directly to the + package page. DO NOT REMOVE THIS FILE!.. autosummary:: + +:toctree: _autosummary +:template: custom-module-template.rst +:recursive: + +aliby +extraction -- GitLab