diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..9534b01 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@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.http://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/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..d43df8f --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,89 @@ +alabaster==0.7.12 +altgraph==0.17 +argh==0.26.2 +awscli==1.18.124 +Babel==2.7.0 +beautifulsoup4==4.9.3 +bitstring==3.1.7 +boto3==1.14.34 +botocore==1.17.47 +certifi==2019.3.9 +cffi==1.14.5 +chardet==3.0.4 +click==7.1.2 +colorama==0.4.1 +commonmark==0.9.1 +cryptography==3.4.7 +Django==2.2.7 +docutils==0.15.2 +ecdsa==0.16.1 +esptool==3.0 +furo==2021.4.11b34 +future==0.18.2 +idna==2.8 +imagesize==1.1.0 +importlib-metadata==2.0.0 +Jinja2==2.10.3 +jmespath==0.10.0 +joblib==0.17.0 +karma-sphinx-theme==0.0.8 +livereload==2.6.1 +lunr==0.5.8 +Markdown==3.3.3 +MarkupSafe==1.1.1 +mkdocs==1.1.2 +mysql-connector==2.2.9 +nltk==3.5 +numpy==1.19.1 +opencv-python==4.4.0.40 +packaging==19.2 +pandas==1.1.1 +pathtools==0.1.2 +pefile==2019.4.18 +Pillow==7.2.0 +port-for==0.3.1 +pyasn1==0.4.8 +pycparser==2.20 +pygame==1.9.6 +Pygments==2.4.2 +PyInstaller==3.6 +PyMySQL==0.9.3 +pyparsing==2.4.2 +PyQt5==5.10.1 +PyQt5-sip==12.8.1 +pyserial==3.5 +python-dateutil==2.8.0 +python-magic==0.4.15 +pytz==2019.3 +pywin32-ctypes==0.2.0 +PyYAML==5.1.2 +recommonmark==0.6.0 +reedsolo==1.5.4 +regex==2020.10.23 +requests==2.21.0 +rsa==4.5 +s3cmd==2.0.2 +s3transfer==0.3.3 +sip==4.19.8 +six==1.12.0 +snowballstemmer==2.0.0 +soupsieve==2.2.1 +Sphinx==3.5.4 +sphinx-autobuild==0.7.1 +sphinx-intl==2.0.1 +sphinx-notfound-page==0.6 +sphinx-rtd-theme==0.4.3 +sphinxcontrib-applehelp==1.0.1 +sphinxcontrib-devhelp==1.0.1 +sphinxcontrib-htmlhelp==1.0.2 +sphinxcontrib-jsmath==1.0.1 +sphinxcontrib-qthelp==1.0.2 +sphinxcontrib-serializinghtml==1.1.3 +spi==0.2.0 +sqlparse==0.3.0 +tornado==6.0.3 +tqdm==4.51.0 +urllib3==1.26.5 +watchdog==0.9.0 +you-get==0.4.1475 +zipp==3.4.0 diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..cc4f56d --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,62 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) +import sphinx_rtd_theme + +html_theme = 'sphinx_rtd_theme' +# -- Project information ----------------------------------------------------- + +project = 'pisloth' +copyright = '2021, sunfounder' +author = 'sunfounder' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +html_js_files = [ + 'https://ezblock.cc/readDocFile/topHead.js', +] +html_css_files = [ + 'https://ezblock.cc/readDocFile/topHead.css', +] diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..42ad262 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,20 @@ +.. pisloth documentation master file, created by + sphinx-quickstart on Fri May 28 18:11:49 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to pisloth's documentation! +=================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search`