crickets-and-comb / crickets-and-comb/shared

Deploy to readthedocs.

Open
#56 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement help wanted
Dominant language
Makefile
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

In the reusable workflow `deploy_docs.yml`, we deploy docs to the GitHub space for documentation hosting, `crickets-and-comb.github.io/` (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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.