crickets-and-comb/shared

Deploy to readthedocs.

Open

#56 opened on 2025年3月27日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)Makefile (0 forks)auto 404
documentationenhancementhelp wanted

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (PR metrics pending)

説明

In the reusable workflow deploy_docs.yml, we deploy docs to the GitHub space for documentation hosting, crickets-and-comb.github.io/<repo> (using the gh-pages branch).

Add to deploy_docs.yml an optional, parametrized job that deploys to readthedocs.com. This obviously depends on an account being set up on readthedocs for the consuming repo, hence the need for this job to be optional and to take whatever parameters are necessary to deploy to the right space.

This may also include updating the build-doc make target, or building a new make target, to satisfy readthedocs.

コントリビューターガイド