From 7f22164bb7e60ce74e8ab270d70b56e0d160adf8 Mon Sep 17 00:00:00 2001 From: Doggy Sasha Date: Mon, 24 Jun 2024 17:20:42 +0300 Subject: [PATCH] =?UTF-8?q?=D0=98=D0=B7=D0=BC=D0=B5=D0=BD=D0=B5=D0=BD?= =?UTF-8?q?=D0=B8=D0=B5=20=D0=BA=D0=BE=D0=BD=D1=84=D0=B8=D0=B3=D0=B0=20RTD?= =?UTF-8?q?=20(14)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/.readthedocs.yaml | 6 +- docs/mkdocs.yml | 6 +- docs/requirements.in | 5 +- docs/requirements.txt | 123 ++++++++++++++++------------ 4 files changed, 81 insertions(+), 59 deletions(-) diff --git a/.github/workflows/.readthedocs.yaml b/.github/workflows/.readthedocs.yaml index d524d61..14ca80d 100644 --- a/.github/workflows/.readthedocs.yaml +++ b/.github/workflows/.readthedocs.yaml @@ -28,6 +28,6 @@ formats: - pdf # Optionally set the version of Python and requirements required to build your docs -# python: -# install: -# - requirements: docs/requirements.txt \ No newline at end of file +python: + install: + - requirements: docs/requirements.txt \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 19149d8..b6fdd5c 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -13,9 +13,9 @@ plugins: docstring_style: sphinx nav: - Туториалы: - - Основа: tutorials/home.md - - Пакеты: tutorials/packets.md - - Первый треугольник: tutorials/triangle.md + - Основа: 'tutorials/home.md' + - Пакеты: 'tutorials/packets.md' + - Первый треугольник: 'tutorials/triangle.md' markdown_extensions: - markdown_include.include: base_path: 'docs/source/' diff --git a/docs/requirements.in b/docs/requirements.in index 440f85f..8c1d861 100644 --- a/docs/requirements.in +++ b/docs/requirements.in @@ -1,2 +1,3 @@ -Sphinx>=7.2,<7.4 -sphinxawesome-theme \ No newline at end of file +mkdocs +mkdocstrings[python] +markdown-include \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt index 4a3fee7..f0a9e7e 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,61 +2,82 @@ # This file is autogenerated by pip-compile with Python 3.10 # by the following command: # -# pip-compile requirements.in +# pip-compile '.\requirements.in' # -alabaster==0.7.12 - # via sphinx -babel==2.10.3 - # via sphinx -beautifulsoup4==4.12.3 - # via sphinxawesome-theme -certifi==2022.6.15 - # via requests -charset-normalizer==2.1.0 - # via requests +click==8.1.7 + # via + # mkdocs + # mkdocstrings colorama==0.4.6 - # via sphinx -docutils==0.20.1 - # via sphinx -idna==3.3 - # via requests -imagesize==1.4.1 - # via sphinx + # via + # click + # griffe + # mkdocs +ghp-import==2.1.0 + # via mkdocs +griffe==0.47.0 + # via mkdocstrings-python jinja2==3.1.2 - # via sphinx + # via + # mkdocs + # mkdocstrings +markdown==3.6 + # via + # markdown-include + # mkdocs + # mkdocs-autorefs + # mkdocstrings + # pymdown-extensions +markdown-include==0.8.1 + # via -r .\requirements.in markupsafe==2.1.1 - # via jinja2 + # via + # jinja2 + # mkdocs + # mkdocs-autorefs + # mkdocstrings +mergedeep==1.3.4 + # via + # mkdocs + # mkdocs-get-deps +mkdocs==1.6.0 + # via + # -r .\requirements.in + # mkdocs-autorefs + # mkdocstrings +mkdocs-autorefs==1.0.1 + # via mkdocstrings +mkdocs-get-deps==0.2.0 + # via mkdocs +mkdocstrings[python]==0.25.1 + # via + # -r .\requirements.in + # mkdocstrings-python +mkdocstrings-python==1.10.5 + # via mkdocstrings packaging==21.3 - # via sphinx -pygments==2.18.0 - # via sphinx + # via mkdocs +pathspec==0.12.1 + # via mkdocs +platformdirs==4.2.2 + # via + # mkdocs-get-deps + # mkdocstrings +pymdown-extensions==10.8.1 + # via mkdocstrings pyparsing==3.0.9 # via packaging -pytz==2022.1 - # via babel -requests==2.28.1 - # via sphinx -snowballstemmer==2.2.0 - # via sphinx -soupsieve==2.5 - # via beautifulsoup4 -sphinx==7.2.6 - # via - # -r requirements.in - # sphinxawesome-theme -sphinxawesome-theme==5.2.0 - # via -r requirements.in -sphinxcontrib-applehelp==1.0.2 - # via sphinx -sphinxcontrib-devhelp==1.0.2 - # via sphinx -sphinxcontrib-htmlhelp==2.0.0 - # via sphinx -sphinxcontrib-jsmath==1.0.1 - # via sphinx -sphinxcontrib-qthelp==1.0.3 - # via sphinx -sphinxcontrib-serializinghtml==1.1.10 - # via sphinx -urllib3==1.26.9 - # via requests +python-dateutil==2.9.0.post0 + # via ghp-import +pyyaml==6.0.1 + # via + # mkdocs + # mkdocs-get-deps + # pymdown-extensions + # pyyaml-env-tag +pyyaml-env-tag==0.1 + # via mkdocs +six==1.16.0 + # via python-dateutil +watchdog==4.0.1 + # via mkdocs