Skip to content
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

0.4.7: sphinx warnings #49

Open
kloczek opened this issue May 21, 2022 · 3 comments
Open

0.4.7: sphinx warnings #49

kloczek opened this issue May 21, 2022 · 3 comments
Labels
bug Something isn't working

Comments

@kloczek
Copy link

kloczek commented May 21, 2022

Looks like sphinx on generate documentation shows few warnings

+ /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.
@kloczek kloczek added the bug Something isn't working label May 21, 2022
@martinRenou
Copy link
Member

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
Copy link
Author

kloczek commented May 25, 2022

Here is my current list of the fixes similar issues in other modules
latchset/jwcrypto#289
click-contrib/sphinx-click@abc31069
latchset/jwcrypto#289
RDFLib/rdflib-sqlalchemy#95

@benbovy
Copy link

benbovy commented Jun 1, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants