Skip to content

Commit 5e7ba54

Browse files
author
Alexander Ororbia
committed
final cleanup/polish/update to docs for v3 nudge
1 parent ee34ef0 commit 5e7ba54

File tree

16 files changed

+206
-273
lines changed

16 files changed

+206
-273
lines changed

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Welcome to ngc-learn's documentation!
2020

2121
tutorials/intro
2222
tutorials/theory
23+
tutorials/configuration/index
2324
tutorials/index
2425
tutorials/neurocog/index
2526

docs/museum/index.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@
55
Model Exhibits
66
==============
77

8-
Models are presented in ngc-learn's model museum in the form of "exhibits", which are effectively model-specific walkthroughs and analyses, based on the relevant, referenced publicly available ngc-learn simulation code.
8+
Models are presented in ngc-learn's model museum in the form of "exhibits", which are effectively model-specific
9+
walkthroughs and analyses, based on the relevant, referenced publicly available ngc-learn simulation code. (Note that
10+
there are more model exhibits in the actual `museum repository <https://github.com/NACLab/ngc-museum>`_ than the number
11+
of detailed walkthroughs presented in the table of contents below.)
912

1013
.. toctree::
1114
:maxdepth: 1
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.. ngc-learn documentation master file, created by
2+
sphinx-quickstart on Wed Apr 20 02:52:17 2022.
3+
Note - This file needs to at least contain a root `toctree` directive.
4+
5+
Configuration Basics
6+
====================
7+
8+
This set of guides provide information about the fundamental building blocks that characterize the NGC-Learn as well
9+
as the operation of NGC-Learn's back-end, NGC-Sim-Lib.
10+
For end-users (experimentalists, engineers), the sections under "Building Blocks" will be most informative. For
11+
developers, the sections under "Development Information" are recommended, particularly for advanced use-cases and
12+
low-level development.
13+
14+
.. toctree::
15+
:maxdepth: 2
16+
:caption: Building Blocks
17+
18+
context
19+
components
20+
compartments
21+
processes
22+
23+
.. toctree::
24+
:maxdepth: 2
25+
:caption: Development Information
26+
27+
global_state
28+
compiling
File renamed without changes.

docs/tutorials/foundations.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)