From eac14eda6192441312b54181842b6446a8c91564 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A1t=C3=A9=20Balajti?= Date: Thu, 19 Sep 2024 13:40:43 +0200 Subject: [PATCH] docs: add installation guide --- docs/{api => }/conf.py | 4 ++-- docs/{api => }/index.rst | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) rename docs/{api => }/conf.py (97%) rename docs/{api => }/index.rst (96%) diff --git a/docs/api/conf.py b/docs/conf.py similarity index 97% rename from docs/api/conf.py rename to docs/conf.py index eacbee59..af28a87f 100644 --- a/docs/api/conf.py +++ b/docs/conf.py @@ -17,7 +17,7 @@ from sphinx.ext import apidoc -sys.path.insert(0, os.path.abspath('../..')) +sys.path.insert(0, os.path.abspath('..')) # -- Project information ----------------------------------------------------- @@ -74,7 +74,7 @@ def run_apidoc(_): "--force", "--module-first", "-o", "./modules", - "../../htsinfer" + "../htsinfer" ] + ignore_paths apidoc.main(argv) diff --git a/docs/api/index.rst b/docs/index.rst similarity index 96% rename from docs/api/index.rst rename to docs/index.rst index 24ae531b..5f99c239 100644 --- a/docs/api/index.rst +++ b/docs/index.rst @@ -14,7 +14,7 @@ HTSinfer Documentation ======================= .. toctree:: - :caption: Contents: + :caption: Contents guides/installation