Skip to content

Commit

Permalink
Add requirements for ReadTheDocs
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
liZe committed Sep 30, 2020
1 parent 3c79bf0 commit 87db898
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,8 @@
# alphabetical (value 'alphabetical'), by member type (value 'groupwise') or by
# source order (value 'bysource'). The default is alphabetical.
autodoc_member_order = 'bysource'

# This value contains a list of modules to be mocked up. This is useful when
# some external dependencies are not met at build time and break the building
# process.
autodoc_mock_imports = ['gi']
10 changes: 10 additions & 0 deletions readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

python:
install:
- requirements: requirements.readthedocs.txt
7 changes: 7 additions & 0 deletions requirements.readthedocs.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
alembic
psycopg2
pydantic
redis
requests
sqlalchemy
toml

0 comments on commit 87db898

Please sign in to comment.