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

Notification: clarify _readthedocs/html path solution #11409

Closed
2 tasks
agjohnson opened this issue Jun 12, 2024 · 0 comments · Fixed by #11410
Closed
2 tasks

Notification: clarify _readthedocs/html path solution #11409

agjohnson opened this issue Jun 12, 2024 · 0 comments · Fixed by #11410
Labels
Improvement Minor improvement to code

Comments

@agjohnson
Copy link
Contributor

agjohnson commented Jun 12, 2024

If you don't output a file during the build, you will see the following notification:

image

However, if you try outputting to this path without using the environment variable, you'll get a path not found error:

echo "Foo" > _readthedocs/html/index.html
/bin/sh: 1: cannot create _readthedocs/html/index.html: Directory nonexistent
  • Maybe note the environment variable in the error notification in addition, or instead of _readthedocs/html.
  • Point to the documentation we have on this environment variable
@agjohnson agjohnson added the Improvement Minor improvement to code label Jun 12, 2024
humitos added a commit that referenced this issue Jul 1, 2024
* Notification: update copy for "No HTML content found"

Closes #11409

* Update readthedocs/notifications/messages.py
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant