diff --git a/docs/_static/custom.css b/docs/_static/custom.css new file mode 100644 index 0000000..e73a1dd --- /dev/null +++ b/docs/_static/custom.css @@ -0,0 +1,4 @@ +/* Increase font size for toctree elements */ +.toctree-l1 { + font-size: 18px; /* Adjust the size as needed */ +} diff --git a/docs/conf.py b/docs/conf.py index b663050..08c429c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -88,3 +88,4 @@ def run_apidoc(_): def setup(app): app.connect('builder-inited', run_apidoc) + app.add_css_file('custom.css') diff --git a/docs/guides/examples.rst b/docs/guides/examples.rst index a93a044..97919dc 100644 --- a/docs/guides/examples.rst +++ b/docs/guides/examples.rst @@ -3,6 +3,7 @@ Examples HTSinfer provides easy-to-use commands for analyzing single- and paired-ended RNA-Seq libraries. + Single-ended Library Example ---------------------------- diff --git a/docs/guides/installation.rst b/docs/guides/installation.rst index 14c007d..dd767cc 100644 --- a/docs/guides/installation.rst +++ b/docs/guides/installation.rst @@ -1,12 +1,12 @@ Installation ============ -This section describes how to install HTSinfer using Conda. +This section describes how to install `HTSinfer` using Conda. Clone the Repository and Install Dependencies --------------------------------------------- -To install HTSinfer, first clone the repository and install the dependencies via `Conda `_: +To install `HTSinfer`, first clone the repository and install the dependencies via `Conda `_: .. code-block:: bash @@ -33,7 +33,7 @@ After the installation is complete, activate the `htsinfer` Conda environment wi Verify the Installation (Optional) ---------------------------------- -If you have installed the development or testing dependencies, you can verify that HTSinfer was installed correctly by executing the tests shipped with the package: +If you have installed the development or testing dependencies, you can verify that `HTSinfer` was installed correctly by executing the tests shipped with the package: .. code-block:: bash diff --git a/docs/guides/usage.rst b/docs/guides/usage.rst index 7c435d3..1971df4 100644 --- a/docs/guides/usage.rst +++ b/docs/guides/usage.rst @@ -1,6 +1,8 @@ Usage ===== +This sections describes the general usage of `HTSinfer`. + General Usage ------------- diff --git a/docs/index.rst b/docs/index.rst index 52351df..b623fad 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,15 +3,20 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to HTSinfer Documentation! -================================== +Welcome to the HTSinfer documentation pages! +============================================ -HTSinfer is a tool for high-throughput sequencing inference. +`HTSinfer` is a command-line tool that infers metadata from Illumina high-throughput sequencing (HTS) data. This documentation will guide you through installation, usage, and the API reference. -HTSinfer Documentation ----------------------- +.. toctree:: + :hidden: + + Home + +Documentation +------------- .. toctree:: :maxdepth: 1 @@ -21,7 +26,7 @@ HTSinfer Documentation guides/examples .. toctree:: - :caption: API Documentation + :caption: API Overview :maxdepth: 1 modules/modules