Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Cannot build documentation and skip notebooks

See original GitHub issue

If I try POLIASTRO_SKIP_NOTEBOOKS=True tox -e docs -v, I get errors like

Traceback (most recent call last):                                                                                     
  File "/home/juanlu/Projects/LSF/poliastro/library/.tox/docs/lib/python3.8/site-packages/sphinx/cmd/build.py", line 280, in build_main
    app.build(args.force_all, filenames)                                                                               
  File "/home/juanlu/Projects/LSF/poliastro/library/.tox/docs/lib/python3.8/site-packages/sphinx/application.py", line 350, in build
    self.builder.build_update()
  File "/home/juanlu/Projects/LSF/poliastro/library/.tox/docs/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 292, in build_update
    self.build(to_build,            
  File "/home/juanlu/Projects/LSF/poliastro/library/.tox/docs/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 306, in build
    updated_docnames = set(self.read())
  File "/usr/lib/python3.8/contextlib.py", line 120, in __exit__
    next(self.gen)                                                                                                                                                                                                                            
  File "/home/juanlu/Projects/LSF/poliastro/library/.tox/docs/lib/python3.8/site-packages/sphinx/util/logging.py", line 213, in pending_warnings
    memhandler.flushTo(logger)                                                                                                                                                                                                                
  File "/home/juanlu/Projects/LSF/poliastro/library/.tox/docs/lib/python3.8/site-packages/sphinx/util/logging.py", line 178, in flushTo
    logger.handle(record)                                                                                                                                                                                                                     
  File "/usr/lib/python3.8/logging/__init__.py", line 1587, in handle
    self.callHandlers(record)                                                                                                                                                                                                                 
  File "/usr/lib/python3.8/logging/__init__.py", line 1649, in callHandlers
    hdlr.handle(record)                                                                                                
  File "/usr/lib/python3.8/logging/__init__.py", line 946, in handle
    rv = self.filter(record)                                                                                                                                                                                                                  
  File "/usr/lib/python3.8/logging/__init__.py", line 807, in filter
    result = f.filter(record)                                                                                                                                                                                                                 
  File "/home/juanlu/Projects/LSF/poliastro/library/.tox/docs/lib/python3.8/site-packages/sphinx/util/logging.py", line 423, in filter
    raise exc                                                                                                          
sphinx.errors.SphinxWarning: /home/juanlu/Projects/LSF/poliastro/library/docs/source/examples/Analyzing NEOs.mystnb:"nbsphinx-thumbnail": No outputs in cell 6
                                                                                                                       
Warning, treated as error:
/home/juanlu/Projects/LSF/poliastro/library/docs/source/examples/Analyzing NEOs.mystnb:"nbsphinx-thumbnail": No outputs in cell 6

So we should either:

Find out if we are misusing nbsphinx,
Or whether this is a bug upstream,
Or wether we should remove the option to skip the notebooks.

Issue Analytics

State:
Created 2 years ago
Comments:10 (7 by maintainers)

Top GitHub Comments

2reactions

astrojuanlucommented, May 1, 2021

Thanks for investigating this @DhruvSondhi ! Maybe we should see if we can temporarily disable the thumbnail generation when notebooks are disabled, or fill them with a dummy thumbnail, allow warnings if not running the notebooks (probably the easiest one), or just remove the possibility of not running the notebooks.

1reaction

astrojuanlucommented, Jun 23, 2021

It works locally for me, yes! Leaving this as a “good first issue” so any newcomer can open a pull request with the change.

Top Results From Across the Web

Building docs fails due to missing pandoc - Stack Overflow

I have created beautiful documentation with readthedocs and sphinx, but I cannot get it to build on the web. How can I either:...

Cannot open or create new Jupyter notebooks #8997 - GitHub

When I try to create a new notebook, I get another error that says, Unexpected error while saving file: Dropbox/iPython Notebooks/Untitled.ipynb ...

Pre-Executing Notebooks — nbsphinx version 0.5.0

Automatically executing notebooks during the Sphinx build process is an important feature of nbsphinx . However, there are a few use cases where ......

Common problems and solutions—ArcGIS Notebook Server

Questions or issues that you may encounter when working with ArcGIS Notebook Server are listed, and solutions are suggested.

Cannot use AzureQuantum Notebooks - Microsoft Q&A

Ques: Why can't I create a "New Notebook"? Why won't the Jupyter Notebook folder open? The notebook and related features require access to...