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

Closed
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
2 participants
@mikand
Contributor

mikand commented Oct 12, 2017

No description provided.

@mikand

This comment has been minimized.

Contributor

mikand commented Oct 12, 2017

@marcogario

This comment has been minimized.

Contributor

marcogario commented Oct 13, 2017

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?

@mikand

This comment has been minimized.

Contributor

mikand commented Oct 13, 2017

Actually, you can execute a notebook:

$ jupyter-nbconvert --to python boolean_logic.ipynb
$ python boolean_logic.py

and you can also automatically generate the markdown in the very same way:

$ jupyter-nbconvert --to markdown boolean_logic.ipynb
$ cat boolean_logic.md

I think I can include a test of this in Travis, not sure how to include this in the docuemntation on readthedocs...

@marcogario

This comment has been minimized.

Contributor

marcogario commented Oct 13, 2017

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.

@mikand

This comment has been minimized.

Contributor

mikand commented Oct 15, 2017

There is a converter also for rst:
$ jupyter-nbconvert --to python boolean_logic.ipynb

However, I do not know how well it performs for complex markup in the cells.

@marcogario marcogario added this to the Backlog milestone Nov 19, 2017

mikand added a commit that referenced this pull request Oct 29, 2018

@mikand

This comment has been minimized.

Contributor

mikand commented Oct 29, 2018

Closing in favor of #535

@mikand mikand closed this Oct 29, 2018

marcogario added a commit that referenced this pull request Oct 30, 2018

Docs: Tutorial on basic boolean solving (#535)
Tutorial on boolean logic derived from the Jupyter notebook from #444.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment