misc_nixos-mailserver/.readthedocs.yaml

# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

build:
  os: ubuntu-22.04
  tools:
    python: "3"
  apt_packages:
    - nix
    - proot
  jobs:
    pre_install:
      - mkdir -p ~/.nix ~/.config/nix
      - echo "experimental-features = nix-command flakes" > ~/.config/nix/nix.conf
      - proot -b ~/.nix:/nix /bin/sh -c "nix build -L .#optionsDoc && cp -v result docs/options.md"

sphinx:
   configuration: docs/conf.py

formats:
  - pdf
  - epub

python:
   install:
   - requirements: docs/requirements.txt
docs: add .readthedocs.yml conf file to pin Python dependencies 2021-11-07 10:13:06 +00:00			`# Read the Docs configuration file`
			`# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details`

			`# Required`
			`version: 2`

			`build:`
docs: use MarkDown for option docs 2022-11-30 21:30:45 +00:00			`os: ubuntu-22.04`
docs: add .readthedocs.yml conf file to pin Python dependencies 2021-11-07 10:13:06 +00:00			`tools:`
docs: use MarkDown for option docs 2022-11-30 21:30:45 +00:00			`python: "3"`
docs: drop options.md from the repository Generate the file on the readthedocs builder using Nix. Since there is no root access or user namespaces, we have to use proot (see https://nixos.wiki/wiki/Nix_Installation_Guide#PRoot). 2022-12-01 13:22:27 +00:00			`apt_packages:`
			`- nix`
			`- proot`
			`jobs:`
			`pre_install:`
			`- mkdir -p ~/.nix ~/.config/nix`
			`- echo "experimental-features = nix-command flakes" > ~/.config/nix/nix.conf`
			`- proot -b ~/.nix:/nix /bin/sh -c "nix build -L .#optionsDoc && cp -v result docs/options.md"`
docs: add .readthedocs.yml conf file to pin Python dependencies 2021-11-07 10:13:06 +00:00
			`sphinx:`
			`configuration: docs/conf.py`

			`formats:`
			`- pdf`
			`- epub`

			`python:`
			`install:`
			`- requirements: docs/requirements.txt`