{% extends "projects/import_base.html" %} {% load blocktrans trans from i18n %} {% block project_add_subheader %} {% trans "Add a configuration file to your project" %} {% endblock project_add_subheader %} {% block project_add_content_classes %} ui fourteen wide tablet twelve wide computer column {% endblock project_add_content_classes %} {% block project_add_content_form %}
{% blocktrans trimmed %} A .readthedocs.yaml file is required at the root of your repository to build your project's documentation. You can pick an example for your documentation tool as a starting point below, and save and commit it to your repository. {% endblocktrans %}
{% trans "Example configuration for:" %}
Sphinx
Sphinx
MkDocs
Pelican
Docusaurus
Jekyll
{% trans "Others" %}
{# The `actionable` class here prevents the select from selecting the text #} {% trans "See more examples" %}
.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 OS, Python version, and other tools you might need
build:
  os: ubuntu-24.04
  tools:
    python: "3.13"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
   configuration: docs/conf.py

# Optionally, but recommended,
# declare the Python requirements required to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
#    install:
#    - requirements: docs/requirements.txt
.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 OS, Python version, and other tools you might need
build:
  os: ubuntu-24.04
  tools:
    python: "3.13"

# Build documentation with Mkdocs
mkdocs:
   configuration: mkdocs.yml

# Optionally, but recommended,
# declare the Python requirements required to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
#    install:
#    - requirements: docs/requirements.txt
.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 OS, Python version, and other tools you might need
build:
  os: ubuntu-24.04
  tools:
    nodejs: "22"

  commands:
    # Install Docusaurus dependencies
    - cd docs/ && npm install
    # Build the site
    - cd docs/ && npm run build
    # Copy generated files into Read the Docs directory
    - mkdir --parents $READTHEDOCS_OUTPUT/html/
    - cp --recursive docs/build/* $READTHEDOCS_OUTPUT/html/
.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 OS, Python version, and other tools you might need
build:
  os: ubuntu-24.04
  tools:
    python: "3.13"

  commands:
    # Install Pelican and its dependencies
    - pip install "pelican[markdown]"
    # Build the site and save generated files into Read the Docs directory
    - pelican --settings docs/pelicanconf.py --output $READTHEDOCS_OUTPUT/html
.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 OS, Python version, and other tools you might need
build:
  os: ubuntu-24.04
  tools:
    ruby: "3.3"

  commands:
    # Install dependencies
    - gem install bundler
    - bundle install
    # Build the site and save generated files into Read the Docs directory
    - jekyll build --destination $READTHEDOCS_OUTPUT/html
.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 OS, Python version, and other tools you might need
build:
  os: ubuntu-24.04
  tools:
    # Specify the language and version your project requires,
    # by uncommenting one of the following tools.
    #
    # python: "3.13"
    # ruby: "3.3"
    # nodejs: "22"
    # rust: "1.82"
    # golang: "1.23"

  commands:
    # Write down your commands here to:
    #
    #  - Install the dependencies of your project
    #  - Build the documentation
    #  - Save the generated files in $READTHEDOCS_OUTPUT/html
{# Show the base form #} {{ block.super }} {% endblock project_add_content_form %} {% block project_add_sidebar_help_topics %} {% include "includes/elements/link.html" with url="https://docs.readthedocs.io/page/config-file/index.html" text="Configuration file tutorial" is_external=True class="item" %} {% include "includes/elements/link.html" with url="https://docs.readthedocs.io/page/config-file/v2.html" text="Configuration file reference" is_external=True class="item" %} {% include "includes/elements/link.html" with url="https://docs.readthedocs.io/page/guides/setup/git-repo-manual.html" text="Manually configuring a Git repository" is_external=True class="item" %} {% endblock project_add_sidebar_help_topics %}