Skip to content

Commit 3f09ebc

Browse files
authored
Docs: Add configuration file for read the docs (#670)
Documentation builds on read the docs are currently failing. The documentation build is trying to install all required pip packages for development. It fails for one C-package that needs compilation. The documentation build does not need all these packages. The configuration can be changed in the admin panel of read the docs or with a configuration file. A configuration file is the recommended way. This commit introduces a basic configuration file for the read the docs documentation build.
1 parent cbabdf3 commit 3f09ebc

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

.readthedocs.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# .readthedocs.yml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Build documentation in the docs/ directory with Sphinx
9+
sphinx:
10+
configuration: docs/conf.py

0 commit comments

Comments
 (0)