From 0182bc6064df33ce8a9a89b7871fdb6e8b33802b Mon Sep 17 00:00:00 2001 From: Christian Herdtweck Date: Fri, 3 Aug 2018 15:45:55 +0200 Subject: [PATCH] Create sphinx docu only of src, not of test --- doc/about_docu.rst | 2 +- doc/modules.rst | 15 +++------------ 2 files changed, 4 insertions(+), 13 deletions(-) diff --git a/doc/about_docu.rst b/doc/about_docu.rst index 2b172e9..0b9788d 100644 --- a/doc/about_docu.rst +++ b/doc/about_docu.rst @@ -7,7 +7,7 @@ How to generate this documentation * Install Sphinx * change dir into doc -* run sphinx-apidoc -o ./ ../ +* run sphinx-apidoc -o ./ ../src (you may have to add a -f if you added a new module) * run make html (this will create one .rst file for each python file in pyi2ncommon directory) diff --git a/doc/modules.rst b/doc/modules.rst index 5909952..e9ff8ac 100644 --- a/doc/modules.rst +++ b/doc/modules.rst @@ -1,16 +1,7 @@ -.. -== +src +=== .. toctree:: :maxdepth: 4 - arnied - buffers - call_helpers - file_helpers - iter_helpers - log_helpers - log_read - follow - test_helpers - type_helpers + src -- 1.7.1