Skip to content

docs: Read the Docs (RTD) deployment pre-requisites #78

@sr-murthy

Description

@sr-murthy

Add:

  • RTD YAML for configuring docs builds
  • A docs requirements.txt (to go in docs/) that includes a full list of versioned project dependencies, including both for the core package (vertex) and app, as well as dependencies unique to Sphinx (as defined in the project TOML. The specific way of generating the docs requirements.txt will vary depending on which dependency manager is being used, but as an example, is possible using PDM with the command:
pdm self update && pdm update -v --dev --no-editable --no-self --update-all && pdm export -v -f requirements --dev -o docs/requirements.txt

where only the last command in this chain is the actual generation step (from the TOML), while the earlier commands update PDM itself and get PDM to update the PDM lockfile that snapshots the current set of all project dependencies.

  • Any other assets required for the deployment, e.g. for custom ISARIC domain configuration

Metadata

Metadata

Assignees

Labels

ciContinuous integrationdocumentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions