Skip to content

Commit

Permalink
updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kaeldai committed Nov 4, 2024
1 parent fc2940d commit 9118866
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 12 deletions.
5 changes: 3 additions & 2 deletions docs/autodocs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,8 @@
# '**': ['custom_sidebar.html', 'localtoc.html', 'searchbox.html'],
# '**': ['user_guide'],
# "simulators_guide": ["user_guide.html"],
# "news_and_events": []
"news_and_events": [],
"contact_us": [],
}

# html_sidebars = {
Expand Down Expand Up @@ -258,5 +259,5 @@ def autodoc_skip_member(app, what, name, obj, skip, options):


def setup(app):
# copy_tutorials()
copy_tutorials()
app.connect('autodoc-skip-member', autodoc_skip_member)
19 changes: 19 additions & 0 deletions docs/autodocs/source/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,24 @@
Tutorials and Examples
######################

.. toctree::
:hidden:
:maxdepth: 1

Builder: Using the Network Builder <tutorial_NetworkBuilder_Intro>
BioNet: Single cell with current injection <tutorial_single_cell_clamped>
BioNet: Single with with synaptic input <tutorial_single_cell_syn>
BioNet: Multiple Nodes with single cell-type <tutorial_single_pop>
BioNet: Heterogeneous network <tutorial_multi_pop>
PointNet: Point-neuron modeling <tutorial_pointnet_modeling>
FilterNet: Full-field flashing movie <tutorial_filter_models>
Auditory FilterNet: Generating stimuli from auditory input <tutorial_auditory_filternet>
PopNet: Population-based firing rate models <tutorial_population_modeling>






Basic Usage
===========
Expand All @@ -16,6 +34,7 @@ Basic Usage


.. grid-item-card:: Building Networks models with the BMTK NetworkBuilder
:link: tutorial_NetworkBuilder_Intro.html

Using the BMTK NetworkBuilder to create SONATA based network models for use in simulation and analysis

Expand Down
21 changes: 11 additions & 10 deletions docs/autodocs/source/user_guide.rst
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
.. toctree::
:hidden:
:maxdepth: 3
:caption: Tutorials

tutorials


.. toctree::
:hidden:
:maxdepth: 2
:caption: User Guide

self
installation
user_guide
builder
simulators_guide
analyzer

.. toctree::
:hidden:
:maxdepth: 2
:caption: Tutorials

tutorials


##########
User Guide
Expand Down Expand Up @@ -44,7 +45,7 @@ Getting Started
:gutter: 1

.. grid-item-card:: Building Networks
:link: builder_guide
:link: builder.rst
:img-bottom: _images/builder_complete_network.jpg

*NetworkBuilder*
Expand All @@ -58,7 +59,7 @@ Getting Started


.. grid-item-card:: Analyzing Networks and Simulations
:link: analzer
:link: analyzer.rst
:img-bottom: _images/raster_120cells_orig.png

*Plotting simulation results and statistics*
Expand Down

0 comments on commit 9118866

Please sign in to comment.