From acb365582d1634553248946940fa6d187df158b4 Mon Sep 17 00:00:00 2001 From: RemiZOffAlex Date: Fri, 25 Oct 2024 22:52:39 +0300 Subject: [PATCH] Update docs --- docs/make.bat | 35 ----------------------------------- docs/source/example.rst | 6 ++++++ docs/source/index.rst | 36 ++++++++++++++++++++++++++++++++++++ 3 files changed, 42 insertions(+), 35 deletions(-) delete mode 100644 docs/make.bat create mode 100644 docs/source/example.rst create mode 100644 docs/source/index.rst diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 6fcf05b..0000000 --- a/docs/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 - -if "%1" == "" goto help - -%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 -) - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd diff --git a/docs/source/example.rst b/docs/source/example.rst new file mode 100644 index 0000000..8af6cbb --- /dev/null +++ b/docs/source/example.rst @@ -0,0 +1,6 @@ +Пример +====== + +.. literalinclude:: ../../example.py + :language: python + :lines: 6- diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..877fad7 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,36 @@ +.. Validator documentation master file, created by + sphinx-quickstart on Sat Feb 19 01:17:02 2022. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Валидатор +========= + +.. toctree:: + :maxdepth: 2 + :caption: Содержание: + + example + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + +Сборка +------ + +.. code:: + + pip install flit + python -m build + +Установка +--------- + +.. code:: + + pip install dist/validator-2.0-py3-none-any.whl