readthedocs / readthedocs-build

Work in Progress builder
19 stars 25 forks source link

Make config file config option complete and a canonical source #29

Closed agjohnson closed 6 years ago

agjohnson commented 7 years ago

Currently, the configuration here is merged in with configuration from Project models in rtfd/readthedocs.org. This makes implementing configuration a confusing process, where configuration defaults here are not the defaults in rtfd/readthedocs.org, and there are discrepancies between the implementations.

Instead, this project should provide a complete configuration, with all of the options we want to move out of readthedocs.org and the admin dashboard -- or move to per-version configuration.

Requirements

Go through project admin dashboard and enumerate all of the configuration options that are missing. We first need to plan on the specification for the configuration structure additions/changes.

Once we have the spec firmed up, we need to add the options to the validation and parsing.

Finally, we can make the change on readthedocs.org that respects this as a canonical form of configuration. We probably still need a abstraction that maps the project configuration and config file configuration, just not in the manner it is structured now.

For instance, now, logic flow looks like this:

This should instead be:

agjohnson commented 6 years ago

Superseded by #50