Skip to content
Snippets Groups Projects
.readthedocs.yaml 761 B
Newer Older
  • Learn to ignore specific revisions
  • Ian Bell's avatar
    Ian Bell committed
    # .readthedocs.yaml
    # Read the Docs configuration file
    # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
    
    # Required
    version: 2
    
    
    Ian Bell's avatar
    Ian Bell committed
    conda:
      environment: doc/environment.yml
    
    
    Ian Bell's avatar
    Ian Bell committed
    # Set the version of Python and other tools you might need
    build:
      os: ubuntu-20.04
      tools:
        python: "3.10"
        # You can also specify other tool versions:
        # nodejs: "16"
        # rust: "1.55"
        # golang: "1.17"
    
    # Build documentation in the docs/ directory with Sphinx
    sphinx:
       configuration: doc/source/conf.py
    
    # If using Sphinx, optionally build your docs in additional formats such as PDF
    # formats:
    #    - pdf
    
    # Optionally declare the Python requirements required to build your docs
    
    #python:
    #   install:
    #   - requirements: doc/requirements.txt