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
Add dynamic event display docs #1077
Conversation
Added a small fix for the wiki friendly html conversion. |
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.
Hi Daniel, nice to add!
- Would we need the
.md
and the notebook both? Otherwise probably adding a link to the.ipynb
in the proper repo would probably be enough? - Would you want to include the HTML file into the md file? I'm sure something like that should be possible with something like
.. image::
- Probably worth changing the headers as below, otherwise they make another section
I think since it is a tool provided along the package it make sense to put it here. In my personal opinion, the other repository has become a bit useless as it is too heavy I stopped using it already a long time ago.
Nice idea also though about it, but I did not want to put any unnecessary weight to the repository.
Ah good catch, I will change it |
Co-authored-by: Joran R. Angevaare <jorana@nikhef.nl>
Co-authored-by: Joran R. Angevaare <jorana@nikhef.nl>
@WenzDaniel should we merge as it is or? I hope that we could somehow embed the html doc into the .md file |
I think we can only keep the notebooks because users will want to directly run the codes. |
@@ -691,6 +691,9 @@ | |||
"nbconvert_exporter": "python", | |||
"pygments_lexer": "ipython3", | |||
"version": "3.8.16" | |||
}, | |||
"nbsphinx": { | |||
"execute": "never" | |||
} |
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.
Here
"nbsphinx": {
"execute": "never"
}
is to disable the execution of the notebook when readthedocs building.
Hi Dacheng thanks for implementing., |
Before you submit this PR: make sure to put all operations-related information in a wiki-note, a PR should be about code and is publicly accessible
What does the code in this PR do / what does it improve?
Adds dynamic event display tutorial to docs. Before it was quite hidden in the analysis code repository.