Skip to content

Commit 69b6ba5

Browse files
committed
Add requirements for ReadTheDocs
Requirements are needed to generate the documentation. Pipfile is not supported yet (see readthedocs/readthedocs.org#3181). We also have to mock gi because ReadTheDocs don’t provide the packages needed to install pygobject.
1 parent e2c12dd commit 69b6ba5

File tree

3 files changed

+22
-0
lines changed

3 files changed

+22
-0
lines changed

docs/source/conf.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,3 +69,8 @@
6969
# alphabetical (value 'alphabetical'), by member type (value 'groupwise') or by
7070
# source order (value 'bysource'). The default is alphabetical.
7171
autodoc_member_order = 'bysource'
72+
73+
# This value contains a list of modules to be mocked up. This is useful when
74+
# some external dependencies are not met at build time and break the building
75+
# process.
76+
autodoc_mock_imports = ['gi']

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+
python:
9+
install:
10+
- requirements: requirements.readthedocs.txt

requirements.readthedocs.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
alembic
2+
psycopg2
3+
pydantic
4+
redis
5+
requests
6+
sqlalchemy
7+
toml

0 commit comments

Comments
 (0)