From dae309249c0887757b3df9179e28ab89079297f8 Mon Sep 17 00:00:00 2001 From: Giampaolo Rodola Date: Mon, 2 Oct 2023 00:04:02 +0200 Subject: [PATCH] new RTD config Signed-off-by: Giampaolo Rodola --- MANIFEST.in | 2 ++ docs/.readthedocs.yaml | 20 ++++++++++++++++++++ docs/requirements.txt | 2 ++ 3 files changed, 24 insertions(+) create mode 100644 docs/.readthedocs.yaml create mode 100644 docs/requirements.txt diff --git a/MANIFEST.in b/MANIFEST.in index 77e48f4c..1f507641 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -17,6 +17,7 @@ include demo/tls_ftpd.py include demo/unix_daemon.py include demo/unix_ftpd.py include demo/winnt_ftpd.py +include docs/.readthedocs.yaml include docs/Makefile include docs/README include docs/adoptions.rst @@ -28,6 +29,7 @@ include docs/images/freebsd.gif include docs/index.rst include docs/install.rst include docs/make.bat +include docs/requirements.txt include docs/rfc-compliance.rst include docs/tutorial.rst include make.bat diff --git a/docs/.readthedocs.yaml b/docs/.readthedocs.yaml new file mode 100644 index 00000000..44ffd968 --- /dev/null +++ b/docs/.readthedocs.yaml @@ -0,0 +1,20 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# RTD recommends specifying your dependencies to enable reproducible builds: +# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..82133027 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +sphinx +sphinx_rtd_theme