Modify model directory documentation UI and related pages #3203
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for this! Could you post a link to the rendered RtD page for this PR? |
clinssen
reviewed
May 2, 2024
I just did, see top comment (you were just too fast :) ) |
jessica-mitchell
commented
May 7, 2024
jessica-mitchell
commented
May 7, 2024
jessica-mitchell
commented
May 7, 2024
…mulator into model-doc-order
This reverts commit d52392c.
clinssen
reviewed
Jul 1, 2024
|
|
||
| .. note:: | ||
|
|
||
| NESTML is also available as part of NEST's official :ref:`docker image <docker>`. |
There was a problem hiding this comment.
Maybe this does not belong here and can be removed.
clinssen
reviewed
Jul 1, 2024
|
|
||
| ---- | ||
|
|
||
| What we mean by `models` |
There was a problem hiding this comment.
Perhaps point out that the models on this page belong to the first category.
clinssen
reviewed
Jul 1, 2024
|
|
||
|
|
||
|
|
||
| Find a model |
There was a problem hiding this comment.
Can this section be eliminated? "Find a model" could go straight to the model selector. The "learn more about" could go as a separate header/paragraph at the bottom of the page.
clinssen
requested changes
Jul 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR modifies the model directory page and how it functions as well as related pages with significant changes. There is now a interactive UI that dynamically loads results of button selection using Javascript.
See Read the Docs output here: https://nest-simulator--3203.org.readthedocs.build/en/3203/models/index.html
The script that extracted the model user docs and built the indices is heavily modified, and renamed to
model_tag_setup.py, The script extracts the text and creates rst model pages and extracts the tags for each model and creates dictionaries,{model: [tags]}and[{tag: "tag", models: ["models"], count: # of models}]. These dictionaries are used in Jinja templates as well as a JSON file is created to be used by Javascript that will render the output client-side.The
models/indexpage now has a 'model selector' that displays each tag, in order of number of models that have that tag (with exception of neuron, synapse and device being the first tags) as multi-select buttons.By clicking on one or more buttons the corresponding models will be displayed.
In addition to the model selector there is also a dropdown that lists in alphabetical order (grouped by neuron, synapse, and device) all models.
Some information from 'models-main' is moved into here. The page also has links to pages for more info on neurons, synapses and devices - these pages will require more work in the future but each of those pages also lists all corresponding models.
When working on this, I found that the pre-commit hook for clang would fail, so changes to it were also done, and fixes #3182
Fixes #2563