Skip to content

Fix: Docs generation create temporary files that are not cleaned up. #10238

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

Merged
merged 2 commits into from
Apr 20, 2025

Conversation

andrewendlinger
Copy link
Contributor

When building the documentation, a couple of example files are written to disk but never deleted.

Currently affected:

  • doc/user-guide/io.rst

    • In line 608 saved_on_disk.h5 is written to disk but never removed
      (note: .h5 files are not exlcuded by .gitignore)
  • doc/internals/time-coding.rst

    • test-datetimes1.nc
    • test-datetimes2.nc
    • test-timedeltas1.nc
    • test-timedeltas2.nc

This PR adds a simple clean up snippet at the end of each affected file / section to get rid of them:

.. ipython:: python
    :suppress:

    # Cleanup
    import os

    for f in ["i_am_a_tmp_example.nc", "tmp_file.h5"]:
        if os.path.exists(f):
            os.remove(f)

@dcherian
Copy link
Contributor

thanks!

@dcherian dcherian merged commit ee862fe into pydata:main Apr 20, 2025
31 of 32 checks passed
dcherian added a commit that referenced this pull request Apr 27, 2025
* main: (76 commits)
  Update how-to-add-new-backend.rst (#10240)
  Support extension array indexes (#9671)
  Switch documentation to pydata-sphinx-theme (#8708)
  Bump codecov/codecov-action from 5.4.0 to 5.4.2 in the actions group (#10239)
  Fix mypy, min-versions CI, xfail Zarr tests (#10255)
  Remove `test_dask_layers_and_dependencies` (#10242)
  Fix: Docs generation create temporary files that are not cleaned up. (#10238)
  opendap / dap4 support for pydap backend (#10182)
  Add RangeIndex (#10076)
  Fix mypy (#10232)
  Fix doctests (#10230)
  Fix broken Sphinx Roles (#10225)
  `DatasetView.map` fix `keep_attrs` (#10219)
  Add datatree repr asv (#10214)
  CI: Automatic PR labelling is back (#10201)
  Fixes dimension order in `xarray.Dataset.to_stacked_array` (#10205)
  Fix references to core classes in docs (#10207)
  Update pre-commit hooks (#10208)
  add `scipy-stubs` as extra `[types]` dependency (#10202)
  Fix sparse dask repr test (#10200)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants