8000 Remove empty doc file by dstansby · Pull Request #1681 · zarr-developers/zarr-python · GitHub
[go: up one dir, main page]

Skip to content

Remove empty doc file #1681

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

Closed
wants to merge 1 commit into from
Closed

Conversation

dstansby
Copy link
Contributor
@dstansby dstansby commented Feb 27, 2024

Potentially fixes #1680. The error on readthedocs is:

WARNING: unknown mimetype for _static/donotdelete, ignoring

I'm not sure what this file is doing - it's empty, I can't find any references to it, and came in 8 years ago with #72. So I guess removing it is fine?

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@sanketverma1704
Copy link
Member

Hi @dstansby.

Thanks for spotting it and sending the PR.

I did a lil' investigation, and it seems like the RTD builds started failing on the mainline after #1560.
This is the last successful build and this is where it started failing.

I've noticed that RTD throws an error when it tries to build the epub format of the documentation:
python -m sphinx -T -W --keep-going -b epub -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/epub

I'm not sure why there's a file named donotdelete in the docs directory, but I'm going to guess that we should not delete it unless absolutely necessary.

I've sent #1694 to remove the epub format. Let's try to see if this fixes the problem.

@dstansby
Copy link
Contributor Author
dstansby commented Mar 6, 2024

👍 looks like the other PR is working, so I'll close this one

@dstansby dstansby closed this Mar 6, 2024
@dstansby dstansby deleted the readthedocs branch March 6, 2024 11:10
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.

Readthedocs doc build failing on main
2 participants
0