Update docs
This commit is contained in:
@@ -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
|
||||
6
docs/source/example.rst
Normal file
6
docs/source/example.rst
Normal file
@@ -0,0 +1,6 @@
|
||||
Пример
|
||||
======
|
||||
|
||||
.. literalinclude:: ../../example.py
|
||||
:language: python
|
||||
:lines: 6-
|
||||
36
docs/source/index.rst
Normal file
36
docs/source/index.rst
Normal file
@@ -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
|
||||
Reference in New Issue
Block a user