From abcceb0fea72c7aa997879900e1f170c8e5caa5b Mon Sep 17 00:00:00 2001 From: Jessica Mitchell Date: Wed, 20 Mar 2024 13:19:25 +0100 Subject: [PATCH 01/12] add old diagram back --- doc/htmldoc/index.rst | 68 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) diff --git a/doc/htmldoc/index.rst b/doc/htmldoc/index.rst index 8071789531..d31c8ebb46 100644 --- a/doc/htmldoc/index.rst +++ b/doc/htmldoc/index.rst @@ -76,6 +76,74 @@ Welcome to the NEST Simulator documentation Discover all our examples! +Conceptual diagram +------------------ + +.. mermaid:: + + %%{ + init:{ + "theme": "base", + "themeVariables": { + "lineColor": "#f63", + "fontSize" : "18px" + } + } + }%% + flowchart LR + + classDef nodeStyle color:#fff, stroke:#fff0, fill:#0E6A93; + classDef nodeStyle2 color:#000, stroke:#fff0, fill:#072f4200; + classDef nodeStyle3 color:#222, stroke:#fff0, fill:#bbb0; + + exp --> nest-simulator + models -->nest-simulator + nest-simulator --> act + + subgraph exp [Experimental protocols] + ir:::nodeStyle3 + end + subgraph nest-simulator [nest-simulator] + direction TB + stimulating_devices:::nodeStyle2 --> simulate + simulate:::nodeStyle2 --> recording_devices:::nodeStyle2 + end + + subgraph models [Built-in or user provided models] + direction LR + neuron_models:::nodeStyle --> network:::nodeStyle + synapse_models:::nodeStyle --> network + + end + subgraph act [Activity data] + smp:::nodeStyle3 + end + + class act sg + class exp sg + class models bg_models + class nest-simulator bg_devices + classDef sg fill:#bbb4, stroke:#4441, color:#111; + classDef bg_models fill:#bbb7, stroke:#3330, color:#000, font-weight: bold; + classDef bg_devices fill:#bbb7, stroke:#3330, color:#000, font-weight: bold; + + %% Note that the spaces used in the "Simulation" text are the copy pasted unicode space character. + %% HTML spaces like %emsp; do not work + simulate(     Simulation     \n) + neuron_models( \n Neuron Models) + synapse_models( \n Synapse Models ) + stimulating_devices( Stimulating Devices) + recording_devices( Recording Devices ) + network( \n Network Models ) + smp( \n spikes, membrane potential, \n synaptic weights, etc.) + ir( \n Input rates, input currents, \n timed sequences, etc.) + click network href "./networks/index.html" + click neuron_models href "./models/index_neuron.html" + click synapse_models href "./models/index_synapse.html" + click stimulating_devices href "./models/index_generator.html" + click recording_devices href "./models/index_device.html" + click simulate href "./nest_behavior/running_simulations.html" + .. toctree:: :caption: USAGE :hidden: From 2d9dd793cb7c70fe551c7dc54dfc3df293892f5d Mon Sep 17 00:00:00 2001 From: Jessica Mitchell Date: Mon, 8 Apr 2024 11:22:59 +0200 Subject: [PATCH 02/12] modify css --- doc/htmldoc/static/css/custom.css | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/doc/htmldoc/static/css/custom.css b/doc/htmldoc/static/css/custom.css index 8937a43743..067b42e5af 100644 --- a/doc/htmldoc/static/css/custom.css +++ b/doc/htmldoc/static/css/custom.css @@ -115,6 +115,14 @@ section#kernel-attributes-nest-nestmodule dd { padding-bottom: 20px !important; box-shadow: 3px 3px var(--nest-orange) !important; } + + +.center { + + text-align: center; + font-style: italic; +} + /************************************************************* * Rules for mermaid diagrams *************************************************************/ @@ -141,12 +149,6 @@ figure.align-default { outline-style: groove; } -.center { - - text-align: center; - font-style: italic; -} - /************************************************************************************** * Rules for carousel * ***********************************************************************************/ @@ -212,10 +214,11 @@ div[role="main"] .md-source { border-radius: 5px; } /* Add padding around buttons on index page */ -#welcome-to-the-nest-simulator-documentation [data-md-color-primary="orange"] .md-typeset a { +#welcome-to-the-nest-simulator-documentation [data-md-color-primary="orange"] .sd-button { padding: 6px; } + .md-typeset details { background-color: white; } @@ -347,6 +350,12 @@ nav.md-nav.md-nav--secondary label.md-nav__title:after{ font-weight: bold; display: flex; align-items: center; + +} + +#welcome-to-the-nest-simulator-documentation .sd-row-cols-lg-1 > *{ +width: 65%; +margin-left: 1.5rem; } #pynest-examples img.sd-card-img-top { From f2cff2d94216d00939c72cbf8257a8c5d1ebfadc Mon Sep 17 00:00:00 2001 From: Jessica Mitchell Date: Mon, 8 Apr 2024 11:27:13 +0200 Subject: [PATCH 03/12] add svg diagram --- .../static/img/excalidraw_nestconcept_dd.svg | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 doc/htmldoc/static/img/excalidraw_nestconcept_dd.svg diff --git a/doc/htmldoc/static/img/excalidraw_nestconcept_dd.svg b/doc/htmldoc/static/img/excalidraw_nestconcept_dd.svg new file mode 100644 index 0000000000..a6aa6b91ba --- /dev/null +++ b/doc/htmldoc/static/img/excalidraw_nestconcept_dd.svg @@ -0,0 +1,21 @@ + + + + + + + + Experimental ProtocolsNeuron ModelsNetwork ModelsSynapse ModelsRecording DevicesStimulation DevicesData AnalysisConnection Rules From fd14f71eca6fdd739aca96ce6390bbf0c1cf8252 Mon Sep 17 00:00:00 2001 From: Jessica Mitchell Date: Mon, 8 Apr 2024 11:27:33 +0200 Subject: [PATCH 04/12] add svg diagram and text --- doc/htmldoc/index.rst | 95 +++++++++++++------------------------------ 1 file changed, 28 insertions(+), 67 deletions(-) diff --git a/doc/htmldoc/index.rst b/doc/htmldoc/index.rst index d31c8ebb46..11879a715a 100644 --- a/doc/htmldoc/index.rst +++ b/doc/htmldoc/index.rst @@ -75,74 +75,35 @@ Welcome to the NEST Simulator documentation Discover all our examples! +.. grid:: + + .. grid-item:: + :columns: 6 + :child-direction: row + :child-align: end + + .. raw:: html + + + + + .. grid-item:: + :columns: 6 + + **How NEST works - Conceptual approach** + + This diagram provides an overview of the components essential for building and simulating a network model with NEST: + The input from stimulation devices, neuron and synapse models, + and connectivity rules. + You can choose what data to record with the recording device. After simulation, the + output is ready for analysis with external tools. + + NEST offers a comprehensive set of predefined components, including over a :doc:`100 models `, a variety of :ref:`connectivity + rules `, :doc:`input devices `, and :doc:`recording options `. Plus, + NEST is flexible, allowing you to implement your own custom + models and extend NEST's functionalities using :doc:`NESTML ` and the :doc:`NEST extension module `, respectively. + -Conceptual diagram ------------------- - -.. mermaid:: - - %%{ - init:{ - "theme": "base", - "themeVariables": { - "lineColor": "#f63", - "fontSize" : "18px" - } - } - }%% - flowchart LR - - classDef nodeStyle color:#fff, stroke:#fff0, fill:#0E6A93; - classDef nodeStyle2 color:#000, stroke:#fff0, fill:#072f4200; - classDef nodeStyle3 color:#222, stroke:#fff0, fill:#bbb0; - - exp --> nest-simulator - models -->nest-simulator - nest-simulator --> act - - subgraph exp [Experimental protocols] - ir:::nodeStyle3 - end - subgraph nest-simulator [nest-simulator] - direction TB - stimulating_devices:::nodeStyle2 --> simulate - simulate:::nodeStyle2 --> recording_devices:::nodeStyle2 - end - - subgraph models [Built-in or user provided models] - direction LR - neuron_models:::nodeStyle --> network:::nodeStyle - synapse_models:::nodeStyle --> network - - end - subgraph act [Activity data] - smp:::nodeStyle3 - end - - class act sg - class exp sg - class models bg_models - class nest-simulator bg_devices - classDef sg fill:#bbb4, stroke:#4441, color:#111; - classDef bg_models fill:#bbb7, stroke:#3330, color:#000, font-weight: bold; - classDef bg_devices fill:#bbb7, stroke:#3330, color:#000, font-weight: bold; - - %% Note that the spaces used in the "Simulation" text are the copy pasted unicode space character. - %% HTML spaces like %emsp; do not work - simulate(     Simulation     \n) - neuron_models( \n Neuron Models) - synapse_models( \n Synapse Models ) - stimulating_devices( Stimulating Devices) - recording_devices( Recording Devices ) - network( \n Network Models ) - smp( \n spikes, membrane potential, \n synaptic weights, etc.) - ir( \n Input rates, input currents, \n timed sequences, etc.) - click network href "./networks/index.html" - click neuron_models href "./models/index_neuron.html" - click synapse_models href "./models/index_synapse.html" - click stimulating_devices href "./models/index_generator.html" - click recording_devices href "./models/index_device.html" - click simulate href "./nest_behavior/running_simulations.html" .. toctree:: :caption: USAGE From 5b9a5e2f0a445f0df9754d9751d5190fd7a0ab47 Mon Sep 17 00:00:00 2001 From: Jessica Mitchell Date: Tue, 9 Apr 2024 14:07:10 +0200 Subject: [PATCH 05/12] update text and sizing --- doc/htmldoc/index.rst | 46 ++++++++++++++++++------------- doc/htmldoc/static/css/custom.css | 3 +- 2 files changed, 28 insertions(+), 21 deletions(-) diff --git a/doc/htmldoc/index.rst b/doc/htmldoc/index.rst index 11879a715a..04f3e99fd1 100644 --- a/doc/htmldoc/index.rst +++ b/doc/htmldoc/index.rst @@ -5,25 +5,33 @@ Welcome to the NEST Simulator documentation .. grid:: + :gutter: 2 .. grid-item:: - NEST is used in computational neuroscience to model and study behavior of large networks of neurons. + .. grid:: 1 1 1 1 + :gutter: 2 + + .. grid-item:: - The models describe single neuron and synapse behavior and their connections. - Different mechanisms of plasticity can be used to investigate artificial learning - and help to shed light on the fundamental principles of how the brain works. + NEST is used in computational neuroscience to model and study behavior of large networks of neurons. - NEST offers convenient and efficient commands to define and connect large networks, - ranging from algorithmically determined connections to data-driven connectivity. - Create connections between neurons using numerous synapse models from STDP to gap junctions. + The models describe single neuron and synapse behavior and their connections. + Different mechanisms of plasticity can be used to investigate artificial learning + and help to shed light on the fundamental principles of how the brain works. - .. button-ref:: tutorials_guides - :ref-type: ref - :shadow: - :color: primary + NEST offers convenient and efficient commands to define and connect large networks, + ranging from algorithmically determined connections to data-driven connectivity. + Create connections between neurons using numerous synapse models from STDP to gap junctions. - Start exploring NEST + .. grid-item:: + + .. button-ref:: tutorials_guides + :ref-type: ref + :shadow: + :color: primary + + Start exploring NEST .. grid-item:: @@ -47,7 +55,7 @@ Welcome to the NEST Simulator documentation .. figure:: static/img/astrocyte_interaction.png - Investigate neuron and astrocyte interactions + Inspect neuron and astrocyte interactions .. figure:: static/img/hpc_benchmark_connectivity.svg @@ -58,7 +66,7 @@ Welcome to the NEST Simulator documentation .. figure:: static/img/pong_sim.gif - Play PONG with NEST + Simulate a game of PONG with NEST .. figure:: static/img/gapjunctions.png @@ -84,11 +92,11 @@ Welcome to the NEST Simulator documentation .. raw:: html - + .. grid-item:: - :columns: 6 + :columns: 5 **How NEST works - Conceptual approach** @@ -98,11 +106,11 @@ Welcome to the NEST Simulator documentation You can choose what data to record with the recording device. After simulation, the output is ready for analysis with external tools. - NEST offers a comprehensive set of predefined components, including over a :doc:`100 models `, a variety of :ref:`connectivity - rules `, :doc:`input devices `, and :doc:`recording options `. Plus, + NEST offers a comprehensive set of predefined components, including over a 100 :doc:`neuron models ` and :doc:`synapse models `, + a variety of :ref:`connection rules `, :doc:`stimulation devices `, and :doc:`recording devices `. Plus, NEST is flexible, allowing you to implement your own custom models and extend NEST's functionalities using :doc:`NESTML ` and the :doc:`NEST extension module `, respectively. - + Check out our wide-ranging list of :doc:`network model ` examples. .. toctree:: diff --git a/doc/htmldoc/static/css/custom.css b/doc/htmldoc/static/css/custom.css index 067b42e5af..d4a4dc97aa 100644 --- a/doc/htmldoc/static/css/custom.css +++ b/doc/htmldoc/static/css/custom.css @@ -354,8 +354,7 @@ nav.md-nav.md-nav--secondary label.md-nav__title:after{ } #welcome-to-the-nest-simulator-documentation .sd-row-cols-lg-1 > *{ -width: 65%; -margin-left: 1.5rem; +width: 85%; } #pynest-examples img.sd-card-img-top { From 331063c869b8809470596ac72abd94835790d22c Mon Sep 17 00:00:00 2001 From: Jessica Mitchell Date: Fri, 7 Jun 2024 21:11:06 +0200 Subject: [PATCH 06/12] make darker --- doc/htmldoc/index.rst | 2 +- ...excalidraw_nestconcept_dd.svg => excalidraw_nestconcept.svg} | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) rename doc/htmldoc/static/img/{excalidraw_nestconcept_dd.svg => excalidraw_nestconcept.svg} (85%) diff --git a/doc/htmldoc/index.rst b/doc/htmldoc/index.rst index 04f3e99fd1..611e5c08c5 100644 --- a/doc/htmldoc/index.rst +++ b/doc/htmldoc/index.rst @@ -92,7 +92,7 @@ Welcome to the NEST Simulator documentation .. raw:: html - + .. grid-item:: diff --git a/doc/htmldoc/static/img/excalidraw_nestconcept_dd.svg b/doc/htmldoc/static/img/excalidraw_nestconcept.svg similarity index 85% rename from doc/htmldoc/static/img/excalidraw_nestconcept_dd.svg rename to doc/htmldoc/static/img/excalidraw_nestconcept.svg index a6aa6b91ba..e82e23facd 100644 --- a/doc/htmldoc/static/img/excalidraw_nestconcept_dd.svg +++ b/doc/htmldoc/static/img/excalidraw_nestconcept.svg @@ -18,4 +18,4 @@ - Experimental ProtocolsNeuron ModelsNetwork ModelsSynapse ModelsRecording DevicesStimulation DevicesData AnalysisConnection Rules + Experimental ProtocolsNeuron ModelsNetwork ModelsSynapse ModelsRecording DevicesStimulation DevicesData AnalysisConnection Rules From 7cc810491f0cd7d98c04e55d45e05e93b01d5823 Mon Sep 17 00:00:00 2001 From: Jessica Mitchell Date: Mon, 10 Jun 2024 14:19:39 +0200 Subject: [PATCH 07/12] update wording --- doc/htmldoc/index.rst | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/doc/htmldoc/index.rst b/doc/htmldoc/index.rst index 611e5c08c5..ca50f3e06a 100644 --- a/doc/htmldoc/index.rst +++ b/doc/htmldoc/index.rst @@ -17,7 +17,7 @@ Welcome to the NEST Simulator documentation NEST is used in computational neuroscience to model and study behavior of large networks of neurons. The models describe single neuron and synapse behavior and their connections. - Different mechanisms of plasticity can be used to investigate artificial learning + Different mechanisms of plasticity can be used to investigate learning and help to shed light on the fundamental principles of how the brain works. NEST offers convenient and efficient commands to define and connect large networks, @@ -101,14 +101,15 @@ Welcome to the NEST Simulator documentation **How NEST works - Conceptual approach** This diagram provides an overview of the components essential for building and simulating a network model with NEST: - The input from stimulation devices, neuron and synapse models, - and connectivity rules. - You can choose what data to record with the recording device. After simulation, the - output is ready for analysis with external tools. - - NEST offers a comprehensive set of predefined components, including over a 100 :doc:`neuron models ` and :doc:`synapse models `, - a variety of :ref:`connection rules `, :doc:`stimulation devices `, and :doc:`recording devices `. Plus, - NEST is flexible, allowing you to implement your own custom + + A NEST simulation is created with input from :doc:`stimulation devices `, + :doc:`neuron models `, and :doc:`synapse models `, + along with :ref:`connection rules `. + You can choose what data to record with :doc:`recording devices `. + After simulation, the output is ready for analysis with external tools. + + + You can find these components in NEST or you can implement your own custom models and extend NEST's functionalities using :doc:`NESTML ` and the :doc:`NEST extension module `, respectively. Check out our wide-ranging list of :doc:`network model ` examples. From eb9461bb2744fe93079b4f8b5cf6c2be9b08e028 Mon Sep 17 00:00:00 2001 From: Jessica Mitchell Date: Tue, 11 Jun 2024 14:12:05 +0200 Subject: [PATCH 08/12] apply suggestions from review --- doc/htmldoc/index.rst | 41 +++++++++++++++---- .../img/excalidraw_nestconcept_horiz.svg | 21 ++++++++++ 2 files changed, 55 insertions(+), 7 deletions(-) create mode 100644 doc/htmldoc/static/img/excalidraw_nestconcept_horiz.svg diff --git a/doc/htmldoc/index.rst b/doc/htmldoc/index.rst index ca50f3e06a..a0c2016b68 100644 --- a/doc/htmldoc/index.rst +++ b/doc/htmldoc/index.rst @@ -1,7 +1,5 @@ -Welcome to the NEST Simulator documentation -=========================================== - - +Welcome to the NEST Simulator documentation! +============================================ .. grid:: @@ -98,15 +96,44 @@ Welcome to the NEST Simulator documentation .. grid-item:: :columns: 5 - **How NEST works - Conceptual approach** + **How NEST works - The Big Picture** + + A NEST simulation is created with input from :doc:`stimulation devices `, + :doc:`neuron models `, and :doc:`synapse models `, + along with :ref:`connection rules `. + You can choose what data to record with :doc:`recording devices `. + After simulation, the output is ready for analysis with NEST's built in :py:mod:`.raster_plot` and :py:mod:`.voltage_trace` + modules or external tools such as :doc:`Elephant `. + + + You can find these components in NEST or you can implement your own custom + models and extend NEST's functionalities using :doc:`NESTML ` and the :doc:`NEST extension module `, respectively. + Check out our wide-ranging list of :doc:`network model ` examples. + +---- + +**How NEST works - The Big Picture** + +.. grid:: + + .. grid-item:: + + .. raw:: html + + + + +.. grid:: + + .. grid-item:: - This diagram provides an overview of the components essential for building and simulating a network model with NEST: A NEST simulation is created with input from :doc:`stimulation devices `, :doc:`neuron models `, and :doc:`synapse models `, along with :ref:`connection rules `. You can choose what data to record with :doc:`recording devices `. - After simulation, the output is ready for analysis with external tools. + After simulation, the output is ready for analysis with NEST's built in :py:mod:`.raster_plot` and :py:mod:`.voltage_trace` + modules or external tools such as :doc:`Elephant `. You can find these components in NEST or you can implement your own custom diff --git a/doc/htmldoc/static/img/excalidraw_nestconcept_horiz.svg b/doc/htmldoc/static/img/excalidraw_nestconcept_horiz.svg new file mode 100644 index 0000000000..d3b365cb5f --- /dev/null +++ b/doc/htmldoc/static/img/excalidraw_nestconcept_horiz.svg @@ -0,0 +1,21 @@ + + + + + + + + Experimental ProtocolsNeuron ModelsNetwork ModelsSynapse ModelsRecording DevicesStimulation DevicesData AnalysisConnection Rules From 79e8823cd3f8efa21da56d074772a2b6681d32db Mon Sep 17 00:00:00 2001 From: Jessica Mitchell Date: Tue, 11 Jun 2024 14:55:01 +0200 Subject: [PATCH 09/12] remove vert diagram and related imgs --- doc/htmldoc/index.rst | 33 ++----------------- .../static/img/excalidraw_nestconcept.svg | 21 ------------ 2 files changed, 2 insertions(+), 52 deletions(-) delete mode 100644 doc/htmldoc/static/img/excalidraw_nestconcept.svg diff --git a/doc/htmldoc/index.rst b/doc/htmldoc/index.rst index a0c2016b68..c131f0175a 100644 --- a/doc/htmldoc/index.rst +++ b/doc/htmldoc/index.rst @@ -81,38 +81,9 @@ Welcome to the NEST Simulator documentation! Discover all our examples! -.. grid:: - - .. grid-item:: - :columns: 6 - :child-direction: row - :child-align: end - - .. raw:: html - - - - - .. grid-item:: - :columns: 5 - - **How NEST works - The Big Picture** - - A NEST simulation is created with input from :doc:`stimulation devices `, - :doc:`neuron models `, and :doc:`synapse models `, - along with :ref:`connection rules `. - You can choose what data to record with :doc:`recording devices `. - After simulation, the output is ready for analysis with NEST's built in :py:mod:`.raster_plot` and :py:mod:`.voltage_trace` - modules or external tools such as :doc:`Elephant `. - - - You can find these components in NEST or you can implement your own custom - models and extend NEST's functionalities using :doc:`NESTML ` and the :doc:`NEST extension module `, respectively. - Check out our wide-ranging list of :doc:`network model ` examples. - ----- -**How NEST works - The Big Picture** +How NEST works - The Big Picture +-------------------------------- .. grid:: diff --git a/doc/htmldoc/static/img/excalidraw_nestconcept.svg b/doc/htmldoc/static/img/excalidraw_nestconcept.svg deleted file mode 100644 index e82e23facd..0000000000 --- a/doc/htmldoc/static/img/excalidraw_nestconcept.svg +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - - - Experimental ProtocolsNeuron ModelsNetwork ModelsSynapse ModelsRecording DevicesStimulation DevicesData AnalysisConnection Rules From 15a5af04623f4637589db02c03781aac03637644 Mon Sep 17 00:00:00 2001 From: Jessica Mitchell Date: Tue, 11 Jun 2024 14:57:44 +0200 Subject: [PATCH 10/12] update link to connectivity concepts --- doc/htmldoc/static/img/excalidraw_nestconcept_horiz.svg | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/htmldoc/static/img/excalidraw_nestconcept_horiz.svg b/doc/htmldoc/static/img/excalidraw_nestconcept_horiz.svg index d3b365cb5f..c188201eec 100644 --- a/doc/htmldoc/static/img/excalidraw_nestconcept_horiz.svg +++ b/doc/htmldoc/static/img/excalidraw_nestconcept_horiz.svg @@ -18,4 +18,4 @@ - Experimental ProtocolsNeuron ModelsNetwork ModelsSynapse ModelsRecording DevicesStimulation DevicesData AnalysisConnection Rules + Experimental ProtocolsNeuron ModelsNetwork ModelsSynapse ModelsRecording DevicesStimulation DevicesData AnalysisConnection Rules From 982cf087b08bbbfd2f5f2e1ced45243702b74764 Mon Sep 17 00:00:00 2001 From: Jessica Mitchell Date: Tue, 11 Jun 2024 21:16:05 +0200 Subject: [PATCH 11/12] make em dash; set svg width/height 100% and preserveaspectraio --- doc/htmldoc/index.rst | 4 ++-- doc/htmldoc/static/img/excalidraw_nestconcept_horiz.svg | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/htmldoc/index.rst b/doc/htmldoc/index.rst index c131f0175a..52c41a7614 100644 --- a/doc/htmldoc/index.rst +++ b/doc/htmldoc/index.rst @@ -82,8 +82,8 @@ Welcome to the NEST Simulator documentation! Discover all our examples! -How NEST works - The Big Picture --------------------------------- +How NEST works --- The Big Picture +---------------------------------- .. grid:: diff --git a/doc/htmldoc/static/img/excalidraw_nestconcept_horiz.svg b/doc/htmldoc/static/img/excalidraw_nestconcept_horiz.svg index c188201eec..828ed3a660 100644 --- a/doc/htmldoc/static/img/excalidraw_nestconcept_horiz.svg +++ b/doc/htmldoc/static/img/excalidraw_nestconcept_horiz.svg @@ -1,4 +1,4 @@ - + From c1ee812c1960816845b3fc839bdc028d81532809 Mon Sep 17 00:00:00 2001 From: Jessica Mitchell Date: Wed, 12 Jun 2024 09:39:31 +0200 Subject: [PATCH 12/12] add css rule for svg object height, fix Safari --- doc/htmldoc/index.rst | 2 +- doc/htmldoc/static/css/custom.css | 14 ++++++++++++-- .../static/img/excalidraw_nestconcept_horiz.svg | 2 +- 3 files changed, 14 insertions(+), 4 deletions(-) diff --git a/doc/htmldoc/index.rst b/doc/htmldoc/index.rst index 52c41a7614..1306ea5ba0 100644 --- a/doc/htmldoc/index.rst +++ b/doc/htmldoc/index.rst @@ -91,7 +91,7 @@ How NEST works --- The Big Picture .. raw:: html - + .. grid:: diff --git a/doc/htmldoc/static/css/custom.css b/doc/htmldoc/static/css/custom.css index d4a4dc97aa..befdde6953 100644 --- a/doc/htmldoc/static/css/custom.css +++ b/doc/htmldoc/static/css/custom.css @@ -122,7 +122,13 @@ section#kernel-attributes-nest-nestmodule dd { text-align: center; font-style: italic; } - +/* Provide a specific height to the svg object on index page + * Reason: Safari does not interpret percentages or max-content + * correctly + * there is an additional @media setting for <768px screens*/ +section#welcome-to-the-nest-simulator-documentation object { + height: 400px; +} /************************************************************* * Rules for mermaid diagrams *************************************************************/ @@ -983,7 +989,11 @@ This is for the larger monitors and possibly full screen viewers. @media only screen and (min-width: 1240px) { #hero h1{ font-size:2em;} } - +@media only screen and (max-width: 768px) { + section#welcome-to-the-nest-simulator-documentation object { + height: 200px; + } +} /* RETINA (2x RESOLUTION DEVICES) This applies to the retina iPhone (4s) and iPad (2,3) along with diff --git a/doc/htmldoc/static/img/excalidraw_nestconcept_horiz.svg b/doc/htmldoc/static/img/excalidraw_nestconcept_horiz.svg index 828ed3a660..c188201eec 100644 --- a/doc/htmldoc/static/img/excalidraw_nestconcept_horiz.svg +++ b/doc/htmldoc/static/img/excalidraw_nestconcept_horiz.svg @@ -1,4 +1,4 @@ - +