canonical / sphinx-docs-starter-pack

A documentation starter-pack
https://canonical-starter-pack.readthedocs-hosted.com/
Other
15 stars 40 forks source link

Be opinionated on fundamental vs customisable configuration #39

Closed pmatulis closed 1 year ago

pmatulis commented 1 year ago

The project should be opinionated on what constitutes fundamental configuration as opposed to user customisation. This will help guarantee consistency across all RTD-enabled doc sets.

Technically, I believe this can be implemented via separate configuration files.

Separate files will also assist in preventing merge conflicts for those remote repositories that choose to stay in sync with the starter-pack project. Remote repositories are those that have adopted the project.

As a distinct effort, we may want to ponder whether syncing should be mandatory or not, since the ultimate goal is to have all RTD-based doc sets have a common look and feel.