treeherder/.readthedocs.yml

# https://docs.readthedocs.io/en/latest/config-file/index.html
version: 2
build:
  os: ubuntu-22.04
  tools:
    python: '3.10'
python:
  install:
    - method: pip
      path: .
      extra_requirements:
        - docs
mkdocs:
  configuration: mkdocs.yml
Bug 1466084 - Docs: Switch to MkDocs and Material theme (#4565) Switches from Sphinx to MkDocs, since it: * supports Markdown natively without requiring hacks like `eval_rst` * validates inline links, ensuring that they are not broken * has a more pleasant live-reloading dev-server * supports the nicer looking mkdocs-material theme * is a third of the size of Sphinx (including deps) The theme change is now possible since Read the Docs have just started supporting use of custom themes (previously they would override the theme and use `readthedocs` theme regardless). 2019-02-06 22:34:08 +03:00			`# https://docs.readthedocs.io/en/latest/config-file/index.html`
			`version: 2`
Make poetry the default method for generating the docs (#6424) This makes sure that serving the documentation via poetry does not regress and we have a single way of generating them. Setting the build backend in `pyproject.toml` makes `pip` to use `poetry` to install the dependencies. By doing so, readthedocs will be able to install the required dependencies to generate the docs (since they don't support poetry directly). 2020-05-15 22:12:35 +03:00			`build:`
adjust readthedocs OS to be unbuntu 22.04 which will support python 3.10 (#7473) 2022-06-29 18:00:28 +03:00			`os: ubuntu-22.04`
			`tools:`
fix typo in .readthedocs.yml file. (#7478) 2022-07-07 15:40:58 +03:00			`python: '3.10'`
Bug 1466084 - Docs: Switch to MkDocs and Material theme (#4565) Switches from Sphinx to MkDocs, since it: * supports Markdown natively without requiring hacks like `eval_rst` * validates inline links, ensuring that they are not broken * has a more pleasant live-reloading dev-server * supports the nicer looking mkdocs-material theme * is a third of the size of Sphinx (including deps) The theme change is now possible since Read the Docs have just started supporting use of custom themes (previously they would override the theme and use `readthedocs` theme regardless). 2019-02-06 22:34:08 +03:00			`python:`
			`install:`
Make poetry the default method for generating the docs (#6424) This makes sure that serving the documentation via poetry does not regress and we have a single way of generating them. Setting the build backend in `pyproject.toml` makes `pip` to use `poetry` to install the dependencies. By doing so, readthedocs will be able to install the required dependencies to generate the docs (since they don't support poetry directly). 2020-05-15 22:12:35 +03:00			`- method: pip`
			`path: .`
			`extra_requirements:`
			`- docs`
Bug 1466084 - Docs: Switch to MkDocs and Material theme (#4565) Switches from Sphinx to MkDocs, since it: * supports Markdown natively without requiring hacks like `eval_rst` * validates inline links, ensuring that they are not broken * has a more pleasant live-reloading dev-server * supports the nicer looking mkdocs-material theme * is a third of the size of Sphinx (including deps) The theme change is now possible since Read the Docs have just started supporting use of custom themes (previously they would override the theme and use `readthedocs` theme regardless). 2019-02-06 22:34:08 +03:00			`mkdocs:`
			`configuration: mkdocs.yml`