docs: add usage and examples pages

zavolanlab · Oct 21, 2024 · acba203 · acba203
1 parent eac14ed
commit acba203
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 17 deletions.
diff --git a/docs/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('../htsinfer'))
 
 
 # -- Project information -----------------------------------------------------
@@ -46,7 +46,14 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'api/yourpackage.rst']
+exclude_patterns = [
+    '_build',
+    'api/yourpackage.rst',
+    'setup.py',
+    'Thumbs.db',
+    '.DS_Store',
+    '.eggs'
+]
 
 # Default doc to search for
 master_doc = 'index'
@@ -61,7 +68,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = []
+html_static_path = ['_static']
 
 
 # -- Automation -------------------------------------------------------------

diff --git a/docs/guides/examples.rst b/docs/guides/examples.rst
@@ -0,0 +1,2 @@
+Examples
+========
diff --git a/docs/guides/installation.rst b/docs/guides/installation.rst
@@ -1,5 +1,5 @@
-Installation Guide
-==================
+Installation
+============
 
 This section describes how to install HTSinfer using Conda.
 

diff --git a/docs/guides/usage.rst b/docs/guides/usage.rst
@@ -0,0 +1,2 @@
+Usage
+=====
diff --git a/docs/index.rst b/docs/index.rst
@@ -11,28 +11,23 @@ HTSinfer is a tool for high-throughput sequencing inference.
 This documentation will guide you through installation, usage, and the API reference.
 
 HTSinfer Documentation
-=======================
+----------------------
 
 .. toctree::
-   :caption: Contents
+   :maxdepth: 1
 
    guides/installation
-
-HTSinfer API docs
-=================
+   guides/usage
+   guides/examples
 
 .. toctree::
-   :caption: Modules
+   :caption: API Documentation
+   :maxdepth: 1
 
    modules/modules
 
-.. toctree::
-   :caption: Index
-
-   indices
-
 Indices and tables
-==================
+------------------
 
 * :ref:`genindex`
 * :ref:`modindex`