Skip to content
Snippets Groups Projects
.readthedocs.yaml 789 B
Newer Older
  • Learn to ignore specific revisions
  • Sun Jin Kim's avatar
    Sun Jin Kim committed
    # .readthedocs.yaml
    # Read the Docs configuration file
    # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
    
    # Required
    version: 2
    
    # Set the version of Python and other tools you might need
    build:
      os: ubuntu-20.04
      tools:
        python: "3.8"
        # You can also specify other tool versions:
        # nodejs: "16"
        # rust: "1.55"
        # golang: "1.17"
    
    # Build documentation in the docs/ directory with Sphinx
    sphinx:
    
    Sun Jin Kim's avatar
    Sun Jin Kim committed
      configuration: docs/conf.py
    
    Sun Jin Kim's avatar
    Sun Jin Kim committed
    
    # 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:
    
    Sun Jin Kim's avatar
    Sun Jin Kim committed
      install:
    
    Sun Jin Kim's avatar
    Sun Jin Kim committed
      # install requirements
      - requirements: docs/requirements.txt
      # install our root directory
      - method: pip
        path: .