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

Fix failing rtd build #15

Merged
merged 7 commits into from
Feb 7, 2025
Merged

Fix failing rtd build #15

merged 7 commits into from
Feb 7, 2025

Conversation

pheuer
Copy link
Owner

@pheuer pheuer commented Feb 7, 2025

No description provided.

@pheuer
Copy link
Owner Author

pheuer commented Feb 7, 2025

First issue had to do with a module with no docstring.

Now getting

Running Sphinx v7.3.7
making output directory... done
[autosummary] generating autosummary for: index.rst, notebooks/applying_cuts_to_a_cpsa_file.ipynb, notebooks/filtration_stacks.ipynb, notebooks/nuclear_reaction_data.ipynb, usage.rst
loading intersphinx inventory from https://docs.python.org/3/objects.inv...
loading intersphinx inventory from https://www.sphinx-doc.org/en/master/objects.inv...
[AutoAPI] Reading files... [  5%] /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/__init__.py
WARNING: Unable to read file: /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/__init__.py
[AutoAPI] Reading files... [ 11%] /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/filtration/srim.py
WARNING: Unable to read file: /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/filtration/srim.py
[AutoAPI] Reading files... [ 16%] /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/filtration/__init__.py
WARNING: Unable to read file: /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/filtration/__init__.py
[AutoAPI] Reading files... [ 21%] /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/filtration/stack.py
WARNING: Unable to read file: /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/filtration/stack.py
[AutoAPI] Reading files... [ 26%] /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/scan/base_scan.py
WARNING: Unable to read file: /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/scan/base_scan.py
[AutoAPI] Reading files... [ 32%] /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/scan/_cli.py
WARNING: Unable to read file: /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/scan/_cli.py
[AutoAPI] Reading files... [ 37%] /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/scan/__init__.py
WARNING: Unable to read file: /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/scan/__init__.py
[AutoAPI] Reading files... [ 42%] /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/scan/cpsa.py
WARNING: Unable to read file: /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/scan/cpsa.py
[AutoAPI] Reading files... [ 47%] /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/scan/subset.py
WARNING: Unable to read file: /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/scan/subset.py
[AutoAPI] Reading files... [ 53%] /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/scan/cut.py
WARNING: Unable to read file: /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/scan/cut.py
[AutoAPI] Reading files... [ 58%] /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/core/ci.py
WARNING: Unable to read file: /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/core/ci.py
[AutoAPI] Reading files... [ 63%] /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/core/exportable_class.py
WARNING: Unable to read file: /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/core/exportable_class.py
[AutoAPI] Reading files... [ 68%] /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/core/types.py
WARNING: Unable to read file: /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/core/types.py
[AutoAPI] Reading files... [ 74%] /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/core/__init__.py
WARNING: Unable to read file: /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/core/__init__.py
[AutoAPI] Reading files... [ 79%] /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/core/units.py
WARNING: Unable to read file: /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/core/units.py
[AutoAPI] Reading files... [ 84%] /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/core/data.py
WARNING: Unable to read file: /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/core/data.py
[AutoAPI] Reading files... [ 89%] /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/models/fusion.py
WARNING: Unable to read file: /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/models/fusion.py
[AutoAPI] Reading files... [ 95%] /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/models/__init__.py
WARNING: Unable to read file: /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/models/__init__.py
[AutoAPI] Reading files... [100%] /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/models/response.py
WARNING: Unable to read file: /home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/src/cr39py/models/response.py

[AutoAPI] Mapping Data... 
[AutoAPI] Rendering Data... 
WARNING: No modules were rendered. Do you need to set autoapi_options to render additional objects?
building [mo]: targets for 0 po files that are out of date
writing output... 
building [html]: targets for 5 source files that are out of date
updating environment: [new config] 5 added, 0 changed, 0 removed
reading sources... [ 20%] index
[AutoAPI] Adding AutoAPI TOCTree [autoapi/index] to index.rst
reading sources... [ 40%] notebooks/applying_cuts_to_a_cpsa_file
reading sources... [ 60%] notebooks/filtration_stacks
reading sources... [ 80%] notebooks/nuclear_reaction_data
reading sources... [100%] usage

/home/docs/checkouts/readthedocs.org/user_builds/cr39py/checkouts/14/docs/source/index.rst:11: WARNING: toctree contains reference to nonexisting document 'autoapi/index'
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets... copying static files... done
copying extra files... done
done
writing output... [ 20%] index

====================== slowest reading durations =======================
0.671 notebooks/applying_cuts_to_a_cpsa_file
0.613 notebooks/filtration_stacks
0.514 notebooks/nuclear_reaction_data
0.018 index
0.003 usage

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/cr39py/envs/14/lib/python3.12/site-packages/sphinx/events.py", line 97, in emit
    results.append(listener.handler(self.app, *args))
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/docs/checkouts/readthedocs.org/user_builds/cr39py/envs/14/lib/python3.12/site-packages/nbsphinx/__init__.py", line 1753, in doctree_resolved
    title = app.env.titles[doc].astext()
            ~~~~~~~~~~~~~~^^^^^
KeyError: 'autoapi/index'

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/cr39py/envs/14/lib/python3.12/site-packages/sphinx/cmd/build.py", line 337, in build_main
    app.build(args.force_all, args.filenames)
  File "/home/docs/checkouts/readthedocs.org/user_builds/cr39py/envs/14/lib/python3.12/site-packages/sphinx/application.py", line 351, in build
    self.builder.build_update()
  File "/home/docs/checkouts/readthedocs.org/user_builds/cr39py/envs/14/lib/python3.12/site-packages/sphinx/builders/__init__.py", line 293, in build_update
    self.build(to_build,
  File "/home/docs/checkouts/readthedocs.org/user_builds/cr39py/envs/14/lib/python3.12/site-packages/sphinx/builders/__init__.py", line 362, in build
    self.write(docnames, list(updated_docnames), method)
  File "/home/docs/checkouts/readthedocs.org/user_builds/cr39py/envs/14/lib/python3.12/site-packages/sphinx/builders/__init__.py", line 570, in write
    self._write_serial(sorted(docnames))
  File "/home/docs/checkouts/readthedocs.org/user_builds/cr39py/envs/14/lib/python3.12/site-packages/sphinx/builders/__init__.py", line 577, in _write_serial
    doctree = self.env.get_and_resolve_doctree(docname, self)
              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/docs/checkouts/readthedocs.org/user_builds/cr39py/envs/14/lib/python3.12/site-packages/sphinx/environment/__init__.py", line 638, in get_and_resolve_doctree
    self.apply_post_transforms(doctree, docname)
  File "/home/docs/checkouts/readthedocs.org/user_builds/cr39py/envs/14/lib/python3.12/site-packages/sphinx/environment/__init__.py", line 696, in apply_post_transforms
    self.events.emit('doctree-resolved', doctree, docname)
  File "/home/docs/checkouts/readthedocs.org/user_builds/cr39py/envs/14/lib/python3.12/site-packages/sphinx/events.py", line 108, in emit
    raise ExtensionError(
sphinx.errors.ExtensionError: Handler <function doctree_resolved at 0x7fa159282160> for event 'doctree-resolved' threw an exception (exception: 'autoapi/index')

Extension error (nbsphinx):
Handler <function doctree_resolved at 0x7fa159282160> for event 'doctree-resolved' threw an exception (exception: 'autoapi/index')

which looks like: readthedocs/readthedocs.org#11975

Copy link

codecov bot commented Feb 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.39%. Comparing base (dbb0cce) to head (4cb9f7e).
Report is 8 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #15   +/-   ##
=======================================
  Coverage   89.39%   89.39%           
=======================================
  Files          15       15           
  Lines        1122     1122           
=======================================
  Hits         1003     1003           
  Misses        119      119           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@pheuer pheuer merged commit 0cc91a8 into main Feb 7, 2025
4 checks passed
@pheuer pheuer deleted the fix_rtd branch February 7, 2025 17:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant