updating documentation

AllenInstitute · Oct 22, 2024 · aa75362 · aa75362
1 parent 9aebe80
commit aa75362
Show file tree

Hide file tree

Showing 13 changed files with 477 additions and 99 deletions.
diff --git a/docs/autodocs/source/_static/custom.css b/docs/autodocs/source/_static/custom.css
@@ -0,0 +1,16 @@
+.bd-main .bd-content .bd-article-container {
+    max-width: 100%;  /* default is 60em */
+}
+
+.bd-page-width {
+    max-width: 100%;
+}
+
+.bd-sidebar {
+    flex: 0 0 300px;
+    max-width: 300px;
+}
+
+.navbar {
+    max-width: 100%; 
+}
diff --git a/docs/autodocs/source/_static/images/bmtk-workflow-v2-simulation-highlighted.png b/docs/autodocs/source/_static/images/bmtk-workflow-v2-simulation-highlighted.png
diff --git a/docs/autodocs/source/_static/images/bmtk_sim_env.2024.png b/docs/autodocs/source/_static/images/bmtk_sim_env.2024.png
diff --git a/docs/autodocs/source/_static/images/ctdb_screenshot.ephys_page.highlighted.png b/docs/autodocs/source/_static/images/ctdb_screenshot.ephys_page.highlighted.png
diff --git a/docs/autodocs/source/conf.py b/docs/autodocs/source/conf.py
@@ -103,21 +103,32 @@
 # html_theme = 'alabaster'
 # html_theme = 'pydata'
 
-# html_css_files = [
-#     'custom.css',
-# ]
+html_css_files = [
+    'custom.css',
+]
 
 html_theme_path = ['.']
 # html_theme = 'aibs_sphinx'
 # html_theme = 'alabaster'
 html_theme = 'pydata_sphinx_theme'
 html_logo = "_static/images/allen-logo.svg"
 html_theme_options = {
-    'logo': '_static/images/allen-logo.svg',
-    "navbar_align": "left",
-    "secondary_sidebar_items": []
+    "show_prev_next": False,             # Do not show the prev & next buttons at the bottom of the page
+    "header_links_before_dropdown": 8,   # By default pyshinx will only show 5 items in navbar then a "more" dropdown. Increase num of items to show all top pages
 }
 
+# html_theme_options = {
+#     # 'logo': '_static/images/allen-logo.svg',
+#     # "navbar_align": "left",
+#     # "secondary_sidebar_items": [],
+#     "show_prev_next": False,
+# }
+
+# html_sidebars = {
+#   "Running Network Simulations with BMTK": []
+# }
+
+
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
@@ -130,20 +141,29 @@
 # html_static_path = ['_static', 'aibs_sphinx/static']
 html_static_path = ['_static']
 html_extra_path = ['../.nojekyll']
-html_theme_options = {
-    "sidebarwidth": "300"
-}
+# html_theme_options = {
+#     # "sidebarwidth": "300",
+#     "navbar_align": "left",
+# }
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
 #
 # This is required for the alabaster theme
 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+# html_sidebars = {
+#     # '**': [
+#     #     'globaltoc.html',
+#     #     'searchbox.html'
+#     # ],
+#     # "simulators_guide": []
+# }
+
 html_sidebars = {
     '**': [
         'globaltoc.html',
-        'searchbox.html'
-    ]
+        # 'searchbox.html'
+    ],
 }
 
 

diff --git a/docs/autodocs/source/contact_us.rst b/docs/autodocs/source/contact_us.rst
@@ -0,0 +1,3 @@
+##########
+Contact Us
+##########
diff --git a/docs/autodocs/source/developers_guide.rst b/docs/autodocs/source/developers_guide.rst
@@ -0,0 +1,3 @@
+##############
+For Developers
+##############
diff --git a/docs/autodocs/source/index.rst b/docs/autodocs/source/index.rst
@@ -1,24 +1,25 @@
-.. Brain Modeling Toolkit documentation master file, created by
-   sphinx-quickstart on Tue Sep 26 10:33:33 2017.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+############################################
+Welcome to the Brain Modeling Toolkit (BMTK)
+############################################
 
-#####################################
-Welcome to the Brain Modeling Toolkit
-=====================================
+
+.. toctree::
+   :hidden:
+
+   About BMTK <self>
 
 .. toctree::
    :maxdepth: 1
    :hidden:
-   :caption: Contents
 
+   About BMTK <index.rst>
    news_and_events
-   Installation <installation>
-   user_guides
-   Example Models <examples>
-   Github <https://github.com/AllenInstitute/bmtk.git>
-   API <bmtk/bmtk>
-   Contact <registration>
+   contact_us
+   installation
+   user_guide
+   tutorials
+   developers_guide
+
 
 
 .. card:: News and Events

diff --git a/docs/autodocs/source/installation.rst b/docs/autodocs/source/installation.rst
@@ -1,5 +1,6 @@
-Installing the BMTK
-===================
+##################
+Installation Guide
+##################
 
 **Users are encouraged to register** `here <https://secure2.convio.net/allins/site/SPageServer/?pagename=modeling_tools>`_ 
 **to receive updates and other communications, but registration is not required to use the package.** 

diff --git a/docs/autodocs/source/news_and_events.rst b/docs/autodocs/source/news_and_events.rst
@@ -1,3 +1,4 @@
 ###############
 News and Events
-###############
+###############
+