You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I tried to add the intermediate page where we suggest a common Sphinx YAML file
for the user to copy and paste.
I found the pattern a little hard to follow. The base template didn't have all
the blocks I needed, so I added some more but I don't feel comfortable with
them.
I also had to create a block to overwrite the CSS classes of the main div, which
sounds weird to me as well.
Besides, I'm not sure how to use the CSS classes to achieve what I need: syntax
highlighting, smaller text, etc.
Make sure your project has a <code>.readthedocs.yaml</code> at the root of your repository. This file is required by Read the Docs to be able to build your documentation. You can <ahref="https://docs.readthedocs.io/en/stable/config-file/v2.html">read more about this in our documentation</a>.
13
+
{% endblocktrans %}
14
+
</p>
15
+
16
+
<pclass="info">
17
+
Here you have an example for a common Sphinx project:
18
+
19
+
<preclass="ui padded">
20
+
<codeclass="ui small text">
21
+
# .readthedocs.yaml
22
+
# Read the Docs configuration file
23
+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
24
+
25
+
# Required
26
+
version: 2
27
+
28
+
# Set the OS, Python version and other tools you might need
29
+
build:
30
+
os: ubuntu-22.04
31
+
tools:
32
+
python: "3.11"
33
+
# You can also specify other tool versions:
34
+
# nodejs: "19"
35
+
# rust: "1.64"
36
+
# golang: "1.19"
37
+
38
+
# Build documentation in the "docs/" directory with Sphinx
39
+
sphinx:
40
+
configuration: docs/conf.py
41
+
42
+
# Optionally build your docs in additional formats such as PDF and ePub
43
+
# formats:
44
+
# - pdf
45
+
# - epub
46
+
47
+
# Optionally, but recommended,
48
+
# declare the Python requirements required to build your documentation
49
+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
0 commit comments