Merge pull request #121 from jjjermiah/docs

Docs
jjjermiah · Feb 25, 2024 · 9b936fd · 9b936fd
2 parents f0a7e11 + edaaa11
commit 9b936fd
Show file tree

Hide file tree

Showing 15 changed files with 418 additions and 210 deletions.
diff --git a/docs/InitializeClient.rst b/docs/InitializeClient.rst
diff --git a/docs/_html_notebooks/test_setup.ipynb b/docs/_html_notebooks/test_setup.ipynb
diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
@@ -0,0 +1,20 @@
+.sphinx-tabs-panel {
+    background: none;
+    border: none;
+    color:aliceblue;
+}
+
+.sphinx-tabs-tab{
+    color: #1D5C87;
+    /* font color */
+    background: none;
+
+}
+
+
+
+.sphinx-tabs-tab[aria-selected="false"]{
+    color: white;
+    /* font color */
+    background: none;
+}
diff --git a/docs/conf.py b/docs/conf.py
@@ -4,6 +4,7 @@
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
+import html
 import os
 import sys
 
@@ -22,9 +23,11 @@
 extensions = [
     "myst_nb",
     "autoapi.extension",
+    "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
     "sphinx_tabs.tabs",
+    "sphinx_exec_code",
 ]
 autoapi_dirs = ["../src/nbiatoolkit"]
 
@@ -33,11 +36,26 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "_html_notebooks"]
 
+
+exec_code_working_dir = ".."
+exec_code_source_folders = ["../src"]
+
+
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
+# html_theme = "piccolo_theme"
 html_theme = "sphinx_rtd_theme"
 
+# # user starts in dark mode
+# default_dark_mode = True
+
 html_static_path = ["_static"]
+
+# html_css_files = [
+#     "css/custom.css",
+# ]
+# def setup(app):
+#     app.add_css_file("css/custom.css")
diff --git a/docs/index.md b/docs/index.md
@@ -7,10 +7,12 @@
 
 markdowns/NBIA.md
 markdowns/Installation.md
-InitializeClient.rst
-Tutorial.ipynb
+tutorial_files/1_InitializeClient.rst
+tutorial_files/2_ExploreCollections.rst
 markdowns/CHANGELOG.md
 markdowns/CONTRIBUTING.md
 markdowns/CONDUCT.md
 autoapi/index
 ```
+
+<!-- Tutorial.ipynb -->
diff --git a/docs/markdowns/Installation.md b/docs/markdowns/Installation.md
@@ -1,9 +1,8 @@
 # Installation
 
-> [!WARNING]
-> `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.
+`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
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,3 +2,6 @@ myst-nb
 sphinx-autoapi
 sphinx-rtd-theme
 sphinx-tabs
+sphinx_exec_code==0.12
+piccolo_theme
+sphinx-rtd-dark-mode