actions-marketplace-validations/Sphinx Docs build with ReadTheDocs Docker

Reproduces ReadTheDocs build in Github Actions (to some degree). Also useful for local build.

Trust Signals

name	description	required	default
RTD_PRJ_NAME	ReadTheDocs project name - also used as name for pdfs and epubs. NOTE: you don't need to actually have a project on readthedocs servers!	yes	myproject
GIT_URL	Full git url to clone the repo	yes	—
GIT_TAG	tag or branch (old repos may use branch master)	no	main
VERSION	version as named on the website	no	latest
REQUIREMENTS	requirements file for pip install	—	requirements.txt
LANGUAGE	Documentation language	no	en
RTD_HTML_SINGLE	builds single page html for offline use. Requires built project to have readthedocs_ext.readthedocs sphinx extension	no	true
RTD_HTML_EXT	builds html exactly as in RTD website. Requires built project to have readthedocs_ext.readthedocs sphinx extension	no	true
READTHEDOCS	If you want to make Sphinx believe you are running on ReadTheDocs server, set this to 'True' (as RTD server does). NOTE: variable MUST be set to a string with capital first character, like 'True' or 'False'!	no	True
GOOGLE_ANALYTICS	A code like UA-123-123-123	no	""

no outputs