From f60112b66942bfde83a14d7dab2e622a4836d2d7 Mon Sep 17 00:00:00 2001 From: Boyan Date: Tue, 13 Feb 2024 20:57:19 +0100 Subject: [PATCH] PLEASE WORK DOCS PLEASE --- .readthedocs.yaml | 16 ++++++++++++++++ {source => docs}/conf.py | 0 {source => docs}/index.rst | 0 docs/requirements.txt | 1 + make.bat | 35 ----------------------------------- 5 files changed, 17 insertions(+), 35 deletions(-) create mode 100644 .readthedocs.yaml rename {source => docs}/conf.py (100%) rename {source => docs}/index.rst (100%) create mode 100644 docs/requirements.txt delete mode 100644 make.bat diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..3d44a14 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,16 @@ + +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.12" + +sphinx: + configuration: docs/conf.py + +python: + version: 3.12 + install: + - requirements: docs/requirements.txt + system_packages: \ No newline at end of file diff --git a/source/conf.py b/docs/conf.py similarity index 100% rename from source/conf.py rename to docs/conf.py diff --git a/source/index.rst b/docs/index.rst similarity index 100% rename from source/index.rst rename to docs/index.rst diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..68273bc --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +sphinx-rtd-theme==1.3.0 \ No newline at end of file diff --git a/make.bat b/make.bat deleted file mode 100644 index 747ffb7..0000000 --- a/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=source -set BUILDDIR=build - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.https://www.sphinx-doc.org/ - exit /b 1 -) - -if "%1" == "" goto help - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd