Open tomMoral opened 2 months ago
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 72.91%. Comparing base (
0b5f931
) to head (8d93d5e
). Report is 23 commits behind head on main.
Note: for building the docs site locally I needed to run the following commands in an empty condo env with python=3.10
:
pip install -e ".[doc,dev]"
pip install jupyter_contrib_nbextensions
pip install --upgrade notebook==6.4.12
pip uninstall traitlets
pip install traitlets==5.9.0
pip uninstall ipython
pip install ipython==8.9.0
...
mkdocs serve
I believe this is due to our custom Jupyter notebook extensions (e.g., jupyter_contrib_nbextensions
) not being compatible with the new notebook 7
release from last year. As a consequence, we need to downgrade notebook
, traitlets
and ipython
.
@tomMoral I made some edits here:
home
pagehome
index.md
for tutorials and API refs and remove the dropdown menu in the navigation barWhat do think of those?
And I have a couple of comments / questions:
docs/tutorials
and docs/examples
and we convert them to markdown at build time. (We also have a tutorial
and a tutorials
folder, but I think this is an artifact of the old release workflow)We could also arrange a video call to discuss.
Related to doc improvements described in #1008