docs: improve documentation structure

Author: jjjermiah

docs/conf.py

@@ -15,6 +15,11 @@
 copyright = "2023, Jermiah Joseph"
 author = "Jermiah Joseph"
 
+import nbiatoolkit
+
+# The full version, including alpha/beta/rc tags
+release: str = nbiatoolkit.__version__
+
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
@@ -28,6 +33,7 @@
     "sphinx.ext.viewcode",
     "sphinx_tabs.tabs",
     "sphinx_exec_code",
+    "sphinx.ext.autosectionlabel",
 ]
 autoapi_dirs = ["../src/nbiatoolkit"]
 

docs/tutorial_files/1_InitializeClient.rst renamed to docs/getting_started/InitializeClient.rst

@@ -118,7 +118,8 @@ If you would like to return the data as a pandas DataFrame, you can pass the
       Feel free to open an issue on the GitHub repository if you would like to see this feature added.
 
 
-Alternatively, you can set the return type for all methods by passing the `return_type` argument to the NBIAClient class.
+Alternatively, you can set the return type for all methods by passing the `return_type` argument when
+initializing the NBIAClient class.
 
 .. tabs::
 
@@ -141,7 +142,8 @@ Alternatively, you can set the return type for all methods by passing the `retur
 
 Logging
 ^^^^^^^
-The client can be initialized with a log level to control the verbosity of the logs. This is primarily intended for debugging and development purposes.
+The client can be initialized with a log level to control the verbosity of the logs. This is primarily
+intended for debugging and development purposes.
 The default log level is 'INFO' and the available log levels are `DEBUG`, `INFO`, `WARNING`, `ERROR`.
 
 .. tabs::

docs/getting_started/Installation.rst

@@ -0,0 +1,40 @@
+Installation
+____________
+
+`nbiatoolkit` is currently under development and is not guaranteed to be stable.
+Please refer to the `1.0.0 Stable Release Milestone <https://github.com/jjjermiah/nbia-toolkit/milestone/1>`_
+for the roadmap to the first stable release.
+
+PyPi Installation
+~~~~~~~~~~~~~~~~~
+
+The easiest way to install `nbiatoolkit` is to use `pip` to install it from the
+`Python Package Index (PyPi) <https://pypi.org/project/nbiatoolkit/>`_.
+
+.. code-block:: console
+
+    $ pip install nbiatoolkit
+
+***NOTE: It is recommended that you install the package in a conda or virtual environment.***
+
+Conda Installation
+~~~~~~~~~~~~~~~~~~
+
+Though the package is not available on conda, you can create a conda environment and install the package using pip:
+
+.. code-block:: console
+
+    $ conda create -n nbia python=3.12
+    $ conda activate nbia
+    $ pip install nbiatoolkit
+
+Virtual Environment Installation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you prefer to use a virtual environment, you can create one and install the package using pip:
+
+.. code-block:: console
+
+    $ python3 -m venv nbia
+    $ source nbia/bin/activate
+    $ pip install nbiatoolkit

docs/markdowns/NBIA.md renamed to docs/getting_started/NBIA.md

@@ -0,0 +1,32 @@
+.. include:: ../README.md
+   :parser: myst_parser.sphinx_
+
+.. toctree::
+    :caption: Getting started
+    :name: getting-started
+    :hidden:
+    :maxdepth: 2
+
+    getting_started/NBIA.md
+    getting_started/Installation.rst
+    getting_started/InitializeClient.rst
+    getting_started/logger.rst
+
+.. toctree::
+    :caption: Querying API
+    :name: querying-api
+    :hidden:
+    :maxdepth: 2
+
+    querying_api/ExploringCollections.rst
+    querying_api/ExploringModalities.rst
+
+.. toctree::
+    :caption: Project Info
+    :name: project-info
+    :hidden:
+    :maxdepth: 2
+
+    project_info/CONTRIBUTING.md
+    project_info/CHANGELOG.md
+    project_info/CONDUCT.md

docs/tutorial_files/logger.rst renamed to docs/getting_started/logger.rst

@@ -1,4 +1,4 @@
-# CHANGELOG
+# Changelog
 
 
 
@@ -40,7 +40,7 @@
 
 * Merge pull request #123 from jjjermiah/development
 
-docs: Start building better documentation.
+docs: Start building better documentation.
 feat: Enhance logging functionality ([`5bb80c3`](https://github.com/jjjermiah/nbia-toolkit/commit/5bb80c3056fab8804ea789aa37702d9fd6741797))
 
 * Merge pull request #122 from jjjermiah/88-logger-functionality

docs/index.md

@@ -1,4 +1,4 @@
-# CODE OF CONDUCT
+# Code of Conduct
 
 ## Our Pledge