-
Notifications
You must be signed in to change notification settings - Fork 357
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
Fix and update model_details notebooks #2453
Conversation
…hten zip to download ipynb
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jessica-mitchell Thanks a lot for this PR! I see three issues with the current state of the PR
- The figures render extremely small in both Safari and Firefox on macOS.
- I would like to keep the notebooks as the primary documents, so that one can easily modify them if needed. RST-files and zip archives should then be automatically generated from the notebooks. Would this be feasible?
- Also, adding zip archives and generated figures to Git risks clogging the repo with binary files as these files evolve. Can we avoid it and just "make" those files on our documentation server?
Sorry, this is because it is not up-to-date with master!
This is a fair point, but I had trouble getting the HTML rendered notebook to generate proper latex and the restructured text version worked easily. I will take another look to see how I can fix it using the notebook as source.
Making these files with sphinxgallery is possible, but it expects a python source. There are other ways I'm sure, which I can look into more. |
…hjax to latest in conf, rm rst zip
@heplesser I looked into this more and discovered that basically the broken equations were missing $$. This seems to resolve the HTML rendering without affecting the output in a notebook running in Jupyter lab. I also updated the mathjax js in the conf, which I dont think did anything but figured we should avoid using outdated versions. |
@heplesser I'm afraid there are some further issues after checking Read the docs rendering which do not seem straightforward |
c32ee30
to
27e4a29
Compare
In The neuron emits a single spike if we should a line break before the unordered list, otherwise; it won't be rendered as a list. |
Side note, the space and position of the references at the bottom do not seem right. Space problem in
|
Can you be more specific? I see a broken link in the third reference ...
Again, I dont see a problem, can you provide more details or screen shot?
What do you mean by horizontal representation? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Otherwise, the rest looks good to me.
Ah this problem, yes this is rendered properly on Read the docs so I didnt notice it, but you're right, in the local build, something strange happens. I have it on my to do list to look into. |
Fixes #2404 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jessica-mitchell Looks good overall, just a few smaller comments.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good now except for formatting error and merge conflict.
@med-ayssar Can you do a final review or approve if looks good? Thanks! |
Looks good! |
This PR moves the model_details notebooks up to top level of hierarchy in htmldoc and fixes issues with rendering of the LaTeX math.
To do this the notebooks were converted to a reStructured text file and output as pngs,
A download link for each notebook was added using a zip file. A direct download of a notebook is not obviously possible with reStructuredText- (if one uses the :download: role with a .ipynb file, the raw notebook code opens).
See for example: https://nest-test.readthedocs.io/en/fix-notebooks-docs/model_details/HillTononiModels.html
Note:
The model_details folder is currently not indexed and not discoverable through the table of contents. They are linked in the respective models/ documentation.
The only notebook not changed is the aeif_models_implementation.ipynb because it does not execute properly. See issue #2454 .