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

allow "x-" options in readthedocs.yml configuration #7288

Closed
wants to merge 1 commit into from
Closed

allow "x-" options in readthedocs.yml configuration #7288

wants to merge 1 commit into from

Conversation

NiklasRosenstein
Copy link

@NiklasRosenstein NiklasRosenstein commented Jul 13, 2020

This Pull Request will allow that options starting with x- can be added to the .readthedocs.yml configuration. This is useful for custom workflows where it makes sense to embed additional options in the Read the Docs configuration. The x- convention is also used by Docker-Compose, for example.

My personal use case for this is to embed the configuration for readthedocs-custom-steps in the configuration directly, instead of a having to use a separate .readthedocs-custom-steps.yml file.

Copy link
Member

@stsewd stsewd left a comment

Choose a reason for hiding this comment

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

@agjohnson
Copy link
Contributor

I would vote no. I don't really want 2 separate tools using the same configuration file. I'd sooner support native custom build steps, I'm not sure it needs to be a separate extension.

@humitos
Copy link
Member

humitos commented Jun 29, 2021

I'm closing this PR. We are moving in a different direction to support custom commands. There are some discussions about this at #8215 #8190

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: design decision A core team decision is required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants