-
Notifications
You must be signed in to change notification settings - Fork 129
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
Added first Jupyter tutorial for Boolean logic #444
Conversation
GitHub now has a viewer for these files: https://github.com/pysmt/pysmt/blob/tutorial/docs/notebooks/boolean_logic.ipynb |
How can we integrate this with the documentation? What I do not like about jupyter notebook is that files cannot be used outside jupyter. For example, there is no obvious way to execute this notebook when we run the CI. For these reasons, I would keep /examples as pure python. However, we have docs/tutorials.rst that (currently) imports every file in /examples . Maybe it would make sense to have this in Jupyter format, and exported as HTML for the documentation? |
Actually, you can execute a notebook:
and you can also automatically generate the markdown in the very same way:
I think I can include a test of this in Travis, not sure how to include this in the docuemntation on readthedocs... |
Our documentation is in restructured text. If we can generate that, then I think we can make a list of some selected examples that would be nice to have as notebooks and manually generate the source for the docs. I do not think that we need to automate the generation from the notebooks to the doc. |
There is a converter also for rst: However, I do not know how well it performs for complex markup in the cells. |
Closing in favor of #535 |
Tutorial on boolean logic derived from the Jupyter notebook from #444.
Tutorial on boolean logic derived from the Jupyter notebook from pysmt#444.
Tutorial on boolean logic derived from the Jupyter notebook from pysmt#444.
No description provided.