From 87db8986023bff55693b6f836276826f257d7627 Mon Sep 17 00:00:00 2001 From: Guillaume Ayoub Date: Wed, 30 Sep 2020 15:32:45 +0200 Subject: [PATCH] Add requirements for ReadTheDocs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Requirements are needed to generate the documentation. Pipfile is not supported yet (see https://github.com/readthedocs/readthedocs.org/issues/3181). We also have to mock gi because ReadTheDocs don’t provide the packages needed to install pygobject. --- docs/source/conf.py | 5 +++++ readthedocs.yml | 10 ++++++++++ requirements.readthedocs.txt | 7 +++++++ 3 files changed, 22 insertions(+) create mode 100644 readthedocs.yml create mode 100644 requirements.readthedocs.txt diff --git a/docs/source/conf.py b/docs/source/conf.py index b5e2c4ac..1602761c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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'] diff --git a/readthedocs.yml b/readthedocs.yml new file mode 100644 index 00000000..b25aef48 --- /dev/null +++ b/readthedocs.yml @@ -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 diff --git a/requirements.readthedocs.txt b/requirements.readthedocs.txt new file mode 100644 index 00000000..f9bf337b --- /dev/null +++ b/requirements.readthedocs.txt @@ -0,0 +1,7 @@ +alembic +psycopg2 +pydantic +redis +requests +sqlalchemy +toml