readthedocs.md

   1 # .readthedocs.yaml\r
   2 # Read the Docs configuration file\r
   3 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details\r
   4 \r
   5 # Required\r
   6 version: 2\r
   7 \r
   8 # Set the version of Python and other tools you might need\r
   9 build:\r
  10   os: ubuntu-20.04\r
  11   tools:\r
  12     python: "3.9"\r
  13     mydocs: "1.4.1"\r
  14     # You can also specify other tool versions:\r
  15     nodejs: "16"\r
  16     rust: "1.55"\r
  17     # golang: "1.17"\r
  18   jobs:\r
  19     pre_create_environment:\r
  20       - echo "Command run at 'pre_create_environment' step"\r
  21     post_build:\r
  22       - echo "Command run at 'post_build' step"\r
  23       - echo `date`\r
  24 \r
  25 # Build documentation in the docs/ directory with Sphinx\r
  26 sphinx:\r
  27    configuration: docs/conf.py\r
  28 \r
  29 # If using Sphinx, optionally build your docs in additional formats such as PDF\r
  30 # formats:\r
  31 #    - pdf\r
  32 \r
  33 # Optionally declare the Python requirements required to build your docs\r
  34 python:\r
  35    install:\r
  36    - requirements: requirements.txt