Read the Docs Settings

• If a project has any Sphinx documentation files, they should be hosted online on readthedocs.org, ideally at a subdomain with the same name as the project.

• Read the Docs sites should be configured as follows:

  • "Advanced Settings" page:
    • Under "Global settings":
      • Set "Default version" to "stable" once at least one release with documentation has been made
    • Under "Default settings":
      • "Documentation Type" — "Sphinx HTML"
      • "Requirements File" - "docs/requirements.txt"
      • "Python Interpreter" — "CPython 3.x"
      • Check "Install Project"
      • Check "Enable PDF Build"
      • Check "Enable EPUB Build"
  • "Notifications" page:
    • Configure notifications to be sent to my e-mail address on build failures

• Tagged versions should always be active

• latest and stable should be active but not master