Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation organisation and landing page #2784

Merged
merged 3 commits into from
Jun 22, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions doc/htmldoc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,11 @@ NEST Simulator documentaiton
:maxdepth: 1
:hidden:

Install NEST <installation/index>
Installation <installation/index>
Tutorials and examples <get-started_index>
Understand how NEST works <understand_index>
PyNEST API <ref_material/pynest_apis>
Built-in models <models/index>
Custom models <https://nestml.readthedocs.io/en/latest/>
Available models <models/index>
Contribute <developer_space/index>
What's new? <whats_new/index>
Community <community>
Expand Down
2 changes: 1 addition & 1 deletion doc/htmldoc/static/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -828,7 +828,7 @@ ul.srt-menu li li li.sfHover ul {

.grid_1 { width: 8.33333333%; }
.grid_2 { width: 16.66666667%; }
.grid_3 { width: 25%; }
.grid_3 { width: 70%; }
.grid_4 { width: 33.33333333%; }
.grid_5 { width: 41.66666667%; }
.grid_6 { width: 50%; }
Expand Down
24 changes: 12 additions & 12 deletions doc/htmldoc/templates/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@
<nav id="topnav" role="navigation">
<div class="menu-toggle">Menu</div>
<ul class="srt-menu" id="menu-main-navigation">
<li><a href="#intro">Get started</a></li>
<li><a href="#topics">Learn NEST</a></li>
<li><a href="#backmatter">Ecosystem</a></li>
<li><a href="https://nest-initiative.org/">The NEST Initiative</a></li>
clinssen marked this conversation as resolved.
Show resolved Hide resolved
<li><a href="https://nest-simulator.readthedocs.io/en/v3.4/related_projects.html">Related tools</a></li>
<li><a href="community.html">Contact and support</a></li>
</ul>
</nav>
</header>
Expand All @@ -51,22 +51,22 @@
<div class="row">
<div class="grid_3">
<h1>Welcome to the NEST Simulator documentation!</h1>
<a href="installation/index.html" class="buttonlink">Install NEST</a>

<p>NEST is a simulator for spiking neural network models that focuses on the dynamics, size and structure of neural systems rather than on the exact morphology of individual neurons.</p>
clinssen marked this conversation as resolved.
Show resolved Hide resolved
<p>NEST is ideal for networks of spiking neurons of any size, and scales flexibly from running on your laptop to high-performance computing systems involving hundreds of compute nodes.</p>
<p>It can be used to simulate small and large-scale models of information processing e.g. in the visual or auditory cortex of mammals, odels of network activity dynamics, e.g. laminar cortical networks or balanced random networks, and supports many models of learning and plasticity.</p>
clinssen marked this conversation as resolved.
Show resolved Hide resolved
</div>
<div class="grid_6">
<a href="installation/index.html" class="buttonlink">Install NEST</a>
<a href="get-started_index.html" class="buttonlink">Tutorials and examples</a>
<a href="ref_material/pynest_apis.html" class="buttonlink">PyNEST API</a>
<a href="models/index.html" class="buttonlink">Built-in Models</a>
<a href="https://nestml.readthedocs.io" class="buttonlink">Custom models</a>
<a href="understand_index.html" class="buttonlink">Further topics</a>
</div>
<div class="grid_3">
<a href="community.html" class="buttonlink" style="float: right;">Contact us</a>
<a href="models/index.html" class="buttonlink">Available models</a>
<a href="understand_index.html" class="buttonlink">How NEST works</a>
</div>
</div>
</section>

<!-- XXX nesting here seems messed up. Run through W3C validator -->
</div>

<section id="intro" class="vertical-padding">
<div id="main" class="blueelement wrapper clearfix">
<div class="row vertical-padding">
Expand Down
Loading