From a484b12b8d27523ebf23aea77febaad4b4905603 Mon Sep 17 00:00:00 2001 From: zhanzghiyong0410 <2556703570@qq.com> Date: Fri, 28 May 2021 18:15:35 +0800 Subject: [PATCH 1/2] rtd --- docs/Makefile | 20 ++++++++++++++ docs/make.bat | 35 ++++++++++++++++++++++++ docs/requirements.txt | Bin 0 -> 3286 bytes docs/source/conf.py | 62 ++++++++++++++++++++++++++++++++++++++++++ docs/source/index.rst | 20 ++++++++++++++ 5 files changed, 137 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/make.bat create mode 100644 docs/requirements.txt create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst 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 0000000000000000000000000000000000000000..5ec84cb9ba8881465ea680e6dc60b144e1ab1981 GIT binary patch literal 3286 zcmbW3L2nyJ429=hpg%>0S5ngSkVA`JS~NfcpLYg@LovR85x=f}5wAKy|V+wCDm zuy7!9$j8S=&iwt?qHM~dEcNZnp>$;^@AdDZ{7`<>*OY1bzI-R^M%HUt7v;X(oO~L2 z**?fxf1j4OI-O^airp&0I?go__uUwM9_N1v44r()K9!B^7hzip)uKEq|GHf1??%yf z`g>pI;XRkvGIlS*`PNr?W#;FbM{4BIg(3BVrdB@*K!qGc|mc z6@8;4s!06Iu6wc(m%V)QJiYY!50Ujwr*`EiA3RX6KNOK3OzNe)uapTdPf}*sN|n}* zHIr8NYb$N;%YzV3q#cypD@v=%=tSa$b5C0@&%>y5ka*5|RYCWxYGm}X#IRzQmJ5KZ)`@^>Ta>> z-Gz_gLH~|{7FAe*bRhLQQKaOHI$$P|JPGMuSerQSDznEh)+!46+6%`y8*}wBtk`;W#Z`ii3d|E8zsbtJ=8mCSX8~i4@jn{cT zDaV^QkBU8EW&sqoGC^xab1lU1J!Ll0BKX#U6`!gxP^4}q(RprD-&*xnBU)vy`m@2& zQhTb;UABH5`)k;$4!l9I9d)u7mT64MA^2dIfsl??MNsLV{KN;G3v|S6VG=S9&FSvC)6NM-lswfr+7VxCD5KL#QQyS<&6O+W@NAPt#HAcpLnQzs5W|qpo4fDgu*0<+8-#xriyz8=#M1f{2^M04Y=DCWw zPjh3|4l^6pt#4P}N!-jt_T*>egJyQ6`muN>$?CJb)0hojNVD+3Ha*+<$Kb6Mb42(1 j9E41uV?62iN9hCo`CW|NbIR-6I{*gI4=BKn-RJ)SGnd;8 literal 0 HcmV?d00001 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` From dcd933ab5a393f5e8d9a1837cfcc32a40ceeb4d1 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 28 May 2021 10:16:25 +0000 Subject: [PATCH 2/2] Bump pyyaml from 5.1.2 to 5.4 in /docs Bumps [pyyaml](https://github.com/yaml/pyyaml) from 5.1.2 to 5.4. - [Release notes](https://github.com/yaml/pyyaml/releases) - [Changelog](https://github.com/yaml/pyyaml/blob/master/CHANGES) - [Commits](https://github.com/yaml/pyyaml/compare/5.1.2...5.4) Signed-off-by: dependabot[bot] --- docs/requirements.txt | Bin 3286 -> 1643 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 5ec84cb9ba8881465ea680e6dc60b144e1ab1981..4d4aedd55785b0928c3570b9b3541efdabf79356 100644 GIT binary patch literal 1643 zcmaJ>%Z}tW47@kcpJKzWp2xw51i2*00JE4=jU(_0MgBK;CEs4tXmsD#W&MEg z?s)i_24(ubL3(vO42ssQ=hY;?hOY0s^091jtaHjyyQS~jvMvET`0QK3>B<%`{5|@p zj%NNw@vc1K>r8P{nK7#p80c(#?R)UxR!47qBuh-BD{DTm z);miPF%|maqqv3ah402N9k=$&h1}wq5=b2nlOI9JBoXAq$ZDLDz}9yRq7pDXG(a22 z!@Ne$t(uyv)&rB9*Ss<{DEhzvdUD8b$_MxyN)Sk$Jx&q^XLen6&Fl6kyRv{a;U*6wSO&&o;{6<0R;T}5R)O$;bZ%<9Am zC%%7zP?Ntp=7ryWu!a|!Z@q%LMZ^eYFcIcuxAbO;(L1Nc>;c6RVrr88eeG<#~>2ef!sv5QmD+dS@nG^5};;n(3-df(u2aY zHpXAs5e>`7x)w9{1@(AxVWZ?~{_L1>*v3FH@oPZioUkp#iq&w-9pJXbDwk2RK>~Vu z-hOo{lQEpq?jcXx%a`97Qj8xqMid&~a=zqK-=BDdXyJLoXOVP36&Pag3N2_7LqV}! zn*v5q>_aa8AZ$dl0{+qCPNCkTKW-XeWMR8%*EYqNx1dBS5#o9Kip3v?^Y%RuOA~%;~0r_Fo2IXa^ zeY?;ui+ZB_E!g=y`_)ZFz%%3ojQMsI^Ys12U`c&mz}{G8LqQ=JbykKa2h*aTJ@NB? zQt$tBd(PH;zh;eu%xCf?S$Wt0iTs9#{8{#2nY(xN2Rz3$MAyA}Y)(vr=Y&@(M&|=r zT6nCECQKW{=ivM{S(&7ab&Uo~rDdo_e1D}po+poO&Nc_&=GS83O)RUnyN3}!bbvCv HQgQzeE)m-s literal 3286 zcmbW3L2nyJ429=hpg%>0S5ngSkVA`JS~NfcpLYg@LovR85x=f}5wAKy|V+wCDm zuy7!9$j8S=&iwt?qHM~dEcNZnp>$;^@AdDZ{7`<>*OY1bzI-R^M%HUt7v;X(oO~L2 z**?fxf1j4OI-O^airp&0I?go__uUwM9_N1v44r()K9!B^7hzip)uKEq|GHf1??%yf z`g>pI;XRkvGIlS*`PNr?W#;FbM{4BIg(3BVrdB@*K!qGc|mc z6@8;4s!06Iu6wc(m%V)QJiYY!50Ujwr*`EiA3RX6KNOK3OzNe)uapTdPf}*sN|n}* zHIr8NYb$N;%YzV3q#cypD@v=%=tSa$b5C0@&%>y5ka*5|RYCWxYGm}X#IRzQmJ5KZ)`@^>Ta>> z-Gz_gLH~|{7FAe*bRhLQQKaOHI$$P|JPGMuSerQSDznEh)+!46+6%`y8*}wBtk`;W#Z`ii3d|E8zsbtJ=8mCSX8~i4@jn{cT zDaV^QkBU8EW&sqoGC^xab1lU1J!Ll0BKX#U6`!gxP^4}q(RprD-&*xnBU)vy`m@2& zQhTb;UABH5`)k;$4!l9I9d)u7mT64MA^2dIfsl??MNsLV{KN;G3v|S6VG=S9&FSvC)6NM-lswfr+7VxCD5KL#QQyS<&6O+W@NAPt#HAcpLnQzs5W|qpo4fDgu*0<+8-#xriyz8=#M1f{2^M04Y=DCWw zPjh3|4l^6pt#4P}N!-jt_T*>egJyQ6`muN>$?CJb)0hojNVD+3Ha*+<$Kb6Mb42(1 j9E41uV?62iN9hCo`CW|NbIR-6I{*gI4=BKn-RJ)SGnd;8