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 YAML Errors in "Formats" section #9876

Merged
merged 2 commits into from
Jan 18, 2024
Merged

Conversation

zoracon
Copy link
Contributor

@zoracon zoracon commented Jan 17, 2024

Parsing errors in read the docs showed this parsing error. Ran things through YAML validation to make sure this time the config files are set.

@zoracon zoracon requested review from a team and bmw and removed request for a team January 17, 2024 22:55
@zoracon zoracon changed the title FIX YAML Errors in "Formats" section Fix YAML Errors in "Formats" section Jan 17, 2024
@bmw
Copy link
Member

bmw commented Jan 18, 2024

So I went to the readthedocs site, logged in, picked a project built from this repo (I used https://readthedocs.org/projects/eff-certbot/), and added this GitHub branch as an "active but hidden" version at https://readthedocs.org/projects/eff-certbot/versions/ which triggered a build. The error message shown there is still "No default configuration file found at repository's root."

Is the problem maybe that readthedocs requires the config file to be in the root of the git repo rather than in a subdirectory? If so, maybe there's a way to conditionally set values in the YAML file depending on the project being built?

Copy link
Member

@bmw bmw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Regardless of that though, this change seems correct to me so feel free to merge.

@zoracon
Copy link
Contributor Author

zoracon commented Jan 18, 2024

Is the problem maybe that readthedocs requires the config file to be in the root of the git repo rather than in a subdirectory? If so, maybe there's a way to conditionally set values in the YAML file depending on the project being built?

Yup, I have to set the directory manually in the admin settings.

@zoracon zoracon merged commit 7ca1b8f into master Jan 18, 2024
16 checks passed
@zoracon zoracon deleted the zoraconpatch-yaml-error branch January 18, 2024 18:45
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.

None yet

2 participants