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.

Sign up for GitHub

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

Jump to bottom

Write a jupyter notebook which highlights functions #22

Open
famosab opened this issue Oct 18, 2022 · 2 comments
Open

Write a jupyter notebook which highlights functions #22

famosab opened this issue Oct 18, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation
Milestone
Good Documentation

Comments

@famosab
Copy link
Collaborator

famosab commented Oct 18, 2022 •
edited
Loading

Jupyter notebooks are a great way to explain the usage of a model. Denote the main functionality in a notebook and add this to the documentation using nbconvert to html.
@famosab famosab added this to the Good Documentation milestone Oct 18, 2022
@draeger
Copy link
Member

draeger commented Oct 20, 2022

Sample notebooks would be of great use.

@famosab famosab mentioned this issue Nov 4, 2022
Closed
famosab added a commit that referenced this issue Nov 7, 2022
@famosab
start ipynb #22
14081e9
famosab added a commit that referenced this issue Nov 7, 2022
@famosab
start ipynb #22
b59a393
famosab added a commit that referenced this issue Nov 7, 2022
@famosab
modifiy gh action for autobuild #22
71f43c7
famosab added a commit that referenced this issue Nov 7, 2022
@famosab
modifiy conf for autobuild #22
ee20418
famosab added a commit that referenced this issue Nov 7, 2022
@famosab
modifiy conf for autobuild #22
2214434
famosab added a commit that referenced this issue Nov 7, 2022
@famosab
modifiy conf for autobuild #22
ab74abf
famosab added a commit that referenced this issue Nov 7, 2022
@famosab
modifiy gh action for autobuild #22
85c6752
famosab added a commit that referenced this issue Nov 7, 2022
@famosab
modify auto-update #22
160ac9f
@famosab
Copy link
Collaborator Author

famosab commented Jan 12, 2023

The above commits all relate to autocompiling the ipynb file into the docs.

@famosab famosab mentioned this issue Jan 31, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Good Documentation
Development

No branches or pull requests
2 participants
@draeger @famosab