From 32a149500ebbfb67249c00160ad3f928627c2126 Mon Sep 17 00:00:00 2001 From: SomberNight Date: Mon, 27 Mar 2023 17:05:39 +0000 Subject: [PATCH] maybe fix readthedocs build --- .cirrus.yml | 7 +++++-- .readthedocs.yml | 13 +++++++++++++ docs/requirements-docs.txt | 1 + 3 files changed, 19 insertions(+), 2 deletions(-) create mode 100644 .readthedocs.yml create mode 100644 docs/requirements-docs.txt diff --git a/.cirrus.yml b/.cirrus.yml index 032d69b6b..10c882a35 100644 --- a/.cirrus.yml +++ b/.cirrus.yml @@ -65,11 +65,14 @@ pycodestyle_task: - pycodestyle --max-line-length=100 electrumx/server/*.py electrumx/lib/*.py *.py build_docs_task: + # note: this build task is not related to read-the-docs; it is only here to sanity-check the docs can be built. + # For the read-the-docs build, see .readthedocs.yml + # and the webhook set up in https://github.com/spesmilo/electrumx/settings/hooks container: - image: python:3.8 + image: python:3.11 cpu: 1 memory: 1G install_script: - - pip install Sphinx + - pip install -r docs/requirements-docs.txt script: - sh -c "cd docs && make html" diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 000000000..c20ab165a --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,13 @@ +version: 2 + +build: + os: ubuntu-20.04 + tools: + python: "3.11" + +sphinx: + configuration: docs/conf.py + +python: + install: + - requirements: docs/requirements-docs.txt diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100644 index 000000000..2806c1649 --- /dev/null +++ b/docs/requirements-docs.txt @@ -0,0 +1 @@ +Sphinx