From f74cd0d741a0b11c8cdb1616f33a377fa91e9ab2 Mon Sep 17 00:00:00 2001 From: Michel Oosterhof Date: Tue, 4 May 2021 00:15:10 +0800 Subject: [PATCH] Readthedocs (#1555) * add readthedocs config file for sphinx-copy button --- .readthedocs.yml | 17 +++++++++++++++++ docs/requirements.txt | 3 +++ 2 files changed, 20 insertions(+) create mode 100644 .readthedocs.yml create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 00000000..6da4538d --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,17 @@ +--- +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Optionally Python version and requirements required to build your docs +python: + version: 3.9 + install: + - requirements: docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..10d88017 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +Sphinx==3.5.4 +sphinx-copybutton==0.3.1 +sphinx_rtd_theme==0.5.2