9 | 
12 | 
15 | 
18 | .readthedocs.yaml", icon="fa-file") %}
18 | {% markdown %}
19 |
20 | ```yaml
21 | version: 2
22 | build:
23 | os: "ubuntu-22.04"
24 | tools:
25 | nodejs: "18"
26 | # You can also specify other tool versions:
27 | # python: "3"
28 | commands:
29 | # "docs/" was created following the Docusaurus tutorial:
30 | # npx create-docusaurus@latest docs classic
31 | #
32 | # Install Docusaurus dependencies
33 | - cd docs/ && npm install
34 | # Build the site
35 | - cd docs/ && npm run build
36 | # Copy generated files into Read the Docs directory
37 | - mkdir --parents $READTHEDOCS_OUTPUT/html/
38 | - cp --recursive docs/build/* $READTHEDOCS_OUTPUT/html/
39 | ```
40 |
41 | {% endmarkdown %}
42 | {% endcall %}
43 | .readthedocs.yaml, and update the commands as necessary.
77 |
78 |
79 |
80 | {%- set header_4 = "Your docs build on every commit" %}
81 | {%- set icon_4 = "fa-square-4" -%}
82 |
83 |
84 |
85 | {{ header_4 }}
86 | Like magic.
87 |
88 |
89 | .readthedocs.yaml", icon="fa-file") %}
18 | {% markdown %}
19 |
20 | ```yaml
21 | version: 2
22 |
23 | build:
24 | os: ubuntu-24.04
25 | tools:
26 | nodejs: "22"
27 | commands:
28 | # Install dependencies
29 | - cd docs/ && npm install
30 | # Build the site
31 | - cd docs/ && npm run build
32 | # Copy generated files into Read the Docs directory
33 | - mkdir --parents $READTHEDOCS_OUTPUT/html/
34 | - cp --verbose --recursive docs/out/* $READTHEDOCS_OUTPUT/html/
35 |
36 | ```
37 |
38 | {% endmarkdown %}
39 | {% endcall %}
40 | .readthedocs.yaml, and update the commands as necessary.
74 |
75 |
76 |
77 | {%- set header_4 = "Your docs build on every commit" %}
78 | {%- set icon_4 = "fa-square-4" -%}
79 |
80 |
81 |
82 | {{ header_4 }}
83 | Like magic.
84 |
85 |
86 | .readthedocs.yaml", icon="fa-file") %}
18 | {% markdown %}
19 |
20 | ```yaml
21 | version: 2
22 | build:
23 | os: ubuntu-22.04
24 | tools:
25 | python: "3.11"
26 | # You can also specify other tool versions:
27 | # nodejs: "16"
28 |
29 | # Build documentation with Mkdocs
30 | mkdocs:
31 | configuration: mkdocs.yml
32 |
33 | # Dependencies required to build your docs
34 | python:
35 | install:
36 | - requirements: requirements.txt
37 | ```
38 | {% endmarkdown %}
39 | {% endcall %}
40 | .readthedocs.yaml", icon="fa-file") %}
18 | {% markdown %}
19 |
20 | ```yaml
21 | version: 2
22 | build:
23 | os: "ubuntu-22.04"
24 | tools:
25 | python: "3"
26 | commands:
27 | # Install Pelican and its dependencies
28 | - pip install "pelican[markdown]"
29 | # Build the site
30 | - pelican \
31 | --settings docs/pelicanconf.py \
32 | --output $READTHEDOCS_OUTPUT/html
33 | ```
34 |
35 | {% endmarkdown %}
36 | {% endcall %}
37 | .readthedocs.yaml, and update the commands as necessary
71 |
72 |
73 |
74 | {%- set header_4 = "Your docs build on every commit" %}
75 | {%- set icon_4 = "fa-square-4" -%}
76 |
77 |
78 |
79 | {{ header_4 }}
80 | Like magic.
81 |
82 |
83 | .readthedocs.yaml", icon="fa-file") %}
18 | {% markdown %}
19 |
20 | ```yaml
21 | version: 2
22 | build:
23 | os: ubuntu-22.04
24 | tools:
25 | python: "3.10"
26 | # You can also specify other tool versions:
27 | # nodejs: "16"
28 |
29 | # Build documentation in the docs/ directory with Sphinx
30 | sphinx:
31 | configuration: docs/conf.py
32 |
33 | # Dependencies required to build your docs
34 | python:
35 | install:
36 | - requirements: docs/requirements.txt
37 | ```
38 |
39 | {% endmarkdown %}
40 | {% endcall %}
41 | 
16 | 
31 | 
46 | 
17 | 
32 | 
47 | 
17 | 
32 | 
47 | 20 | While there are many options for hosting documentation, 21 | Read the Docs is purpose-built for technical documentation with features that make both documentation authors and readers more productive. 22 |
23 |24 | Compare Read the Docs with other popular documentation platforms to find the best solution for your needs. 25 |
26 | {% endcall %} 27 |75 | Read the Docs is the all-in-one solution that provides everything you need 76 | for hosting documentation, from authentication to versioning. 77 | Try it today and see the difference! 78 |
79 | 80 |81 | 84 | 85 | Get started for free 86 | 87 |
88 || 10 | |
11 | |
13 |
14 | 
15 | |
16 |
|---|
19 | {{ caller() }} 20 |
21 |
37 |
38 |
44 | {{ caller() }} 45 |
46 |14 | {{ caller() }} 15 |16 | 17 |
...
45 | {% endcall %} 46 | {% endcall %} 47 | 48 | #} 49 | {% macro highlight_list() %} 50 |Body text
78 | {% endcall %} 79 | 80 | #} 81 | {% macro highlight_item(icon, header, color="primary", icon_style=None) %} 82 |.readthedocs.yaml", icon="fa-file") %}
10 | {% markdown %}
11 | ```yaml
12 | build:
13 | commands:
14 | - true
15 | ```
16 | {% endmarkdown %}
17 | {% endcall %}
18 | #}
19 | {% macro code_block(title, icon=None) %}
20 |