.readthedocs.yaml configuration file is required at the root of your repository in order to build your documentation.
{% endblocktrans %}
-
-
- {% trans "Learn how to add a configuration file to your project." %}
-
.readthedocs.yaml
-
-
+
+
+
+ .readthedocs.yaml
+
+
+
+
+
+
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
@@ -59,7 +54,7 @@
build:
os: ubuntu-22.04
tools:
- python: "3.11"
+ python: "3.12"
# You can also specify other tool versions:
# nodejs: "19"
# rust: "1.64"
@@ -80,8 +75,203 @@
# 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-22.04
+ tools:
+ python: "3.12"
+ # You can also specify other tool versions:
+ # nodejs: "19"
+ # rust: "1.64"
+ # golang: "1.19"
+
+# 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-22.04
+ tools:
+ nodejs: "19"
+ # You can also specify other tool versions:
+ # python: "3.12"
+ # rust: "1.64"
+ # golang: "1.19"
+
+ 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-22.04
+ tools:
+ python: "3.12"
+ # You can also specify other tool versions:
+ # nodejs: "19"
+ # rust: "1.64"
+ # golang: "1.19"
+
+ 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-22.04
+ tools:
+ ruby: "3.3"
+ # You can also specify other tool versions:
+ # python: "3.12"
+ # nodejs: "19"
+ # rust: "1.64"
+ # golang: "1.19"
+
+ commands:
+ # Install dependencies
+ - gem install bundle
+ - 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-22.04
+ tools:
+ # Specify the language and version your project requires,
+ # by uncommenting one of the following tools.
+ #
+ # python: "3.12"
+ # ruby: "3.3"
+ # nodejs: "19"
+ # rust: "1.64"
+ # golang: "1.19"
+
+ 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 #}