Skip to content

Automate ReadTheDocs version activation #97

@dmayo3

Description

@dmayo3

Problem

New version documentation builds need to be manually enabled in the ReadTheDocs admin panel after each release.

Current Manual Process

  1. Go to ReadTheDocs admin panel
  2. Navigate to project settings
  3. Find the newly created version
  4. Manually activate/enable it

Impact

  • Adds manual overhead to release process
  • Documentation may not be immediately available after release
  • Requires admin panel access for release managers

Proposed Solution

Investigate automation options:

  • Research ReadTheDocs API for automatic version activation
  • Explore webhook integration to trigger documentation builds
  • Consider GitHub Actions integration with ReadTheDocs
  • Evaluate if this can be incorporated into existing release workflow

Success Criteria

  • New versions are automatically activated on ReadTheDocs
  • Documentation is available immediately after release
  • No manual intervention required in ReadTheDocs admin panel
  • Solution is integrated into release workflow

Priority

Enhancement that would improve release process efficiency. Not a major hardship currently, so can be addressed in a later milestone.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementGeneral tweaks and improvements

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions