File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 44# Required
55version : 2
66
7- # Set the OS, Python version and other tools you might need
7+ # Set the OS, Python version and other tools you might need.
88build :
99 os : ubuntu-22.04
1010 tools :
@@ -14,22 +14,24 @@ build:
1414 # rust: "1.70"
1515 # golang: "1.20"
1616
17- # Build documentation in the "docs /" directory with Sphinx
17+ # Build documentation in the "doc /" directory with Sphinx.
1818sphinx :
1919 configuration : doc/source/conf.py
2020 # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
2121 # builder: "dirhtml"
2222 # Fail on all warnings to avoid broken references
23- # fail_on_warning: true
23+ fail_on_warning : true
2424
25- # Optionally build your docs in additional formats such as PDF and ePub
25+ # Optionally build your docs in additional formats such as PDF and ePub.
2626# formats:
27- # - pdf
28- # - epub
27+ # - pdf
28+ # - epub
2929
3030# Optional but recommended, declare the Python requirements required
31- # to build your documentation
31+ # to build your documentation.
3232# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
33- # python:
34- # install:
35- # - requirements: docs/requirements.txt
33+ python :
34+ install :
35+ - method : pip
36+ path : .
37+ - requirements : doc/requirements.txt
Original file line number Diff line number Diff line change 9393# Options for HTML output
9494# -----------------------
9595
96- # html_theme = "sphinx_rtd_theme"
96+ html_theme = "sphinx_rtd_theme"
9797html_theme_options = {}
9898
9999# The name for this set of Sphinx documents. If None, it defaults to
You can’t perform that action at this time.
0 commit comments