-
Notifications
You must be signed in to change notification settings - Fork 4
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
Make tutorials interactive with binder #115
Conversation
There are now 3 tutorials that can be run on binder (cuds_api, ontology_interface and wrapper_development) |
I checked and indeed they work fine. However, I am experiencing a strange problem with this branch: the CUDS API tutorial and the Ontology Interface tutorials do not show up on the table of contents. @pablo-de-andres Are you able to see them there? |
My bad. I renamed some files, because there was an inconsistency between |
I have tracked down a bit better the error of the Binder badge not being displayed when using the Docker image. It happens because the python Docker image it is based on is itself based on Debian Buster, and at least one of the packages I have discovered this using this modified dockerfile, which installs Pandoc from Debian Bullseye. This triggers the update of the above mentioned packages. FROM python:3.8-buster
RUN apt-get update
RUN apt-get install -y default-jre graphviz
RUN apt-get install -y texlive-latex-recommended \
texlive-latex-extra \
texlive-fonts-recommended \
latexmk
RUN sed -i 's/buster/bullseye/g' /etc/apt/sources.list
RUN sed -i 's\bullseye/updates\bullseye-security\g' /etc/apt/sources.list
RUN apt-get update
RUN apt-get install -y pandoc
WORKDIR /app
ADD . .
RUN pip install -r requirements.txt
CMD sphinx-autobuild --host 0.0.0.0 docs/source docs/build/html
# Build:
# $ docker build -f local_build.Dockerfile -t simphony-docs .
# Run:
# $ docker run --rm -v $PWD:/app -p 8000:8000 simphony-docs For now I suggest that we do not do anything more in this regard, as whether the bug will be happening on readthedocs or not will depend on the software stack installed in there. We may put effort in fixing it in the end this actually happens. |
I also centered the Binder badges. |
I believe they were centered by default (or so it showed on my vscode Notebook) |
About the tooltip of the Binder badges, I think that nbsphinx (the plugin that renders notebooks in the docs) is breaking it. It seems to keep only a handful of HTML tags after the conversion. See #468 on nbsphinx's repo. There is nothing we can do to fix this. |
Do not worry, I think it also has something to do with nbsphinx. |
closes #80