search

jupyterlite / jupyterlite-sphinx

Sphinx extension using JupyterLite to render Notebooks
https://jupyterlite-sphinx.readthedocs.io/en/latest
BSD 3-Clause "New" or "Revised" License
67 stars 20 forks source link

0.4.7: sphinx warnings #49

Open kloczek opened 2 years ago

kloczek commented 2 years ago

Looks like sphinx on generate documentation shows few warnings

```console + /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man Running Sphinx v4.5.0 making output directory... done building [mo]: targets for 0 po files that are out of date building [man]: all manpages updating environment: [new config] 9 added, 0 changed, 0 removed reading sources... [100%] installation looking for now-outdated files... none found pickling environment... done checking consistency... /home/tkloczko/rpmbuild/BUILD/jupyterlite-sphinx-0.4.7/docs/bqplot.ipynb: WARNING: document isn't included in any toctree /home/tkloczko/rpmbuild/BUILD/jupyterlite-sphinx-0.4.7/docs/directives/my_notebook.ipynb: WARNING: document isn't included in any toctree done writing... python-jupyterlite-sphinx.3 { installation configuration directives/jupyterlite directives/retrolite directives/replite full } done build succeeded, 2 warnings. ```
martinRenou commented 2 years ago

Thanks, I don't know what we can do with this. The Notebook are indeed not included in the doctree, but they are not supposed to be included. We need a way to tell sphinx to ignore the ipynb files.

kloczek commented 2 years ago

Here is my current list of the fixes similar issues in other modules https://github.com/latchset/jwcrypto/pull/289 https://github.com/click-contrib/sphinx-click/commit/abc31069 https://github.com/latchset/jwcrypto/pull/289 https://github.com/RDFLib/rdflib-sqlalchemy/issues/95

benbovy commented 2 years ago

Maybe via a "orphan": true notebook metadata entry? This seems to be what MyST-NB uses to ignore the warnings.

Carreau commented 1 month ago

I believe this has been fixed since this issue has been opened. It would be great for someone to try to reproduce and confirm. Thanks.

melissawm commented 1 month ago

I was trying to look into this but I am also hitting #177 when building the docs.

agriyakhetarpal commented 1 month ago

I have faced #177 before (with unusually slow download speeds, rather) and what I usually do for local development is that I uninstall the Xeus kernel for local development because of said problem, since it's not necessarily required.

I've tried to reproduce this and I don't see any warnings for orphan pages such as the one(s) suggested.