From 89101227100808f06eb8fe828e22153a1e2967c2 Mon Sep 17 00:00:00 2001 From: yupix Date: Tue, 14 Mar 2023 16:32:29 +0900 Subject: [PATCH] =?UTF-8?q?chore:=20sphinx=E5=91=A8=E3=82=8A=E4=BD=BF?= =?UTF-8?q?=E3=82=8F=E3=81=AA=E3=81=84=E3=81=AE=E3=81=A7=E5=89=8A=E9=99=A4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/Makefile | 20 ----- docs/conf.py | 39 ---------- docs/index.rst | 22 ------ docs/main.rst | 7 -- docs/make.bat | 35 --------- docs/mipac.abc.rst | 37 --------- docs/mipac.actions.rst | 53 ------------- docs/mipac.core.models.rst | 21 ------ docs/mipac.core.rst | 18 ----- docs/mipac.manager.admin.rst | 21 ------ docs/mipac.manager.rst | 141 ----------------------------------- docs/mipac.models.rst | 93 ----------------------- docs/mipac.rst | 66 ---------------- docs/mipac.types.rst | 133 --------------------------------- docs/modules.rst | 7 -- docs/requirements.txt | 5 -- 16 files changed, 718 deletions(-) delete mode 100644 docs/Makefile delete mode 100644 docs/conf.py delete mode 100644 docs/index.rst delete mode 100644 docs/main.rst delete mode 100644 docs/make.bat delete mode 100644 docs/mipac.abc.rst delete mode 100644 docs/mipac.actions.rst delete mode 100644 docs/mipac.core.models.rst delete mode 100644 docs/mipac.core.rst delete mode 100644 docs/mipac.manager.admin.rst delete mode 100644 docs/mipac.manager.rst delete mode 100644 docs/mipac.models.rst delete mode 100644 docs/mipac.rst delete mode 100644 docs/mipac.types.rst delete mode 100644 docs/modules.rst delete mode 100644 docs/requirements.txt diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index d4bb2cb..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# 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 = . -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/conf.py b/docs/conf.py deleted file mode 100644 index 1f83670..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,39 +0,0 @@ -# Configuration file for the Sphinx documentation builder. -# -# For the full list of built-in configuration values, see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Project information ----------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information - -import os -import sys - -sys.path.insert(0, os.path.abspath('../')) - -project = 'MiPAC' -copyright = '2022, yupix' -author = 'yupix' -release = '0.2.0' -sys.path.append(os.path.abspath('extensions')) - -# -- General configuration --------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration - -extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.napoleon', - 'sphinxcontrib_trio', - 'sphinx.ext.autosummary', - 'sphinx.ext.todo', -] - -templates_path = ['_templates'] -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - - -# -- Options for HTML output ------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output - -html_theme = 'furo' -html_static_path = ['_static'] diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 8cb9ac7..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. MiPAC documentation master file, created by - sphinx-quickstart on Tue Oct 4 16:51:54 2022. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to MiPAC's documentation! -================================= - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - -mipac \ No newline at end of file diff --git a/docs/main.rst b/docs/main.rst deleted file mode 100644 index eace87b..0000000 --- a/docs/main.rst +++ /dev/null @@ -1,7 +0,0 @@ -main module -=========== - -.. automodule:: main - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 954237b..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=. -set BUILDDIR=_build - -%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 -) - -if "%1" == "" goto help - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd diff --git a/docs/mipac.abc.rst b/docs/mipac.abc.rst deleted file mode 100644 index 34c75b6..0000000 --- a/docs/mipac.abc.rst +++ /dev/null @@ -1,37 +0,0 @@ -mipac.abc package -================= - -Submodules ----------- - -mipac.abc.action module ------------------------ - -.. automodule:: mipac.abc.action - :members: - :undoc-members: - :show-inheritance: - -mipac.abc.manager module ------------------------- - -.. automodule:: mipac.abc.manager - :members: - :undoc-members: - :show-inheritance: - -mipac.abc.model module ----------------------- - -.. automodule:: mipac.abc.model - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: mipac.abc - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/mipac.actions.rst b/docs/mipac.actions.rst deleted file mode 100644 index 84eb81d..0000000 --- a/docs/mipac.actions.rst +++ /dev/null @@ -1,53 +0,0 @@ -mipac.actions package -===================== - -Submodules ----------- - -mipac.actions.admin module --------------------------- - -.. automodule:: mipac.actions.admin - :members: - :undoc-members: - :show-inheritance: - -mipac.actions.drive module --------------------------- - -.. automodule:: mipac.actions.drive - :members: - :undoc-members: - :show-inheritance: - -mipac.actions.my module ------------------------ - -.. automodule:: mipac.actions.my - :members: - :undoc-members: - :show-inheritance: - -mipac.actions.note module -------------------------- - -.. automodule:: mipac.actions.note - :members: - :undoc-members: - :show-inheritance: - -mipac.actions.user module -------------------------- - -.. automodule:: mipac.actions.user - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: mipac.actions - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/mipac.core.models.rst b/docs/mipac.core.models.rst deleted file mode 100644 index 0b74e09..0000000 --- a/docs/mipac.core.models.rst +++ /dev/null @@ -1,21 +0,0 @@ -mipac.core.models package -========================= - -Submodules ----------- - -mipac.core.models.chart module ------------------------------- - -.. automodule:: mipac.core.models.chart - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: mipac.core.models - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/mipac.core.rst b/docs/mipac.core.rst deleted file mode 100644 index 0f5904d..0000000 --- a/docs/mipac.core.rst +++ /dev/null @@ -1,18 +0,0 @@ -mipac.core package -================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - mipac.core.models - -Module contents ---------------- - -.. automodule:: mipac.core - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/mipac.manager.admin.rst b/docs/mipac.manager.admin.rst deleted file mode 100644 index 4690fa7..0000000 --- a/docs/mipac.manager.admin.rst +++ /dev/null @@ -1,21 +0,0 @@ -mipac.manager.admin package -=========================== - -Submodules ----------- - -mipac.manager.admin.user module -------------------------------- - -.. automodule:: mipac.manager.admin.user - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: mipac.manager.admin - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/mipac.manager.rst b/docs/mipac.manager.rst deleted file mode 100644 index 8e25956..0000000 --- a/docs/mipac.manager.rst +++ /dev/null @@ -1,141 +0,0 @@ -mipac.manager package -===================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - mipac.manager.admin - -Submodules ----------- - -mipac.manager.ad module ------------------------ - -.. automodule:: mipac.manager.ad - :members: - :undoc-members: - :show-inheritance: - -mipac.manager.chart module --------------------------- - -.. automodule:: mipac.manager.chart - :members: - :undoc-members: - :show-inheritance: - -mipac.manager.chat module -------------------------- - -.. automodule:: mipac.manager.chat - :members: - :undoc-members: - :show-inheritance: - -mipac.manager.client module ---------------------------- - -.. automodule:: mipac.manager.client - :members: - :undoc-members: - :show-inheritance: - -mipac.manager.drive module --------------------------- - -.. automodule:: mipac.manager.drive - :members: - :undoc-members: - :show-inheritance: - -mipac.manager.emoji module --------------------------- - -.. automodule:: mipac.manager.emoji - :members: - :undoc-members: - :show-inheritance: - -mipac.manager.favorite module ------------------------------ - -.. automodule:: mipac.manager.favorite - :members: - :undoc-members: - :show-inheritance: - -mipac.manager.file module -------------------------- - -.. automodule:: mipac.manager.file - :members: - :undoc-members: - :show-inheritance: - -mipac.manager.follow module ---------------------------- - -.. automodule:: mipac.manager.follow - :members: - :undoc-members: - :show-inheritance: - -mipac.manager.moderator module ------------------------------- - -.. automodule:: mipac.manager.moderator - :members: - :undoc-members: - :show-inheritance: - -mipac.manager.my module ------------------------ - -.. automodule:: mipac.manager.my - :members: - :undoc-members: - :show-inheritance: - -mipac.manager.note module -------------------------- - -.. automodule:: mipac.manager.note - :members: - :undoc-members: - :show-inheritance: - -mipac.manager.page module -------------------------- - -.. automodule:: mipac.manager.page - :members: - :undoc-members: - :show-inheritance: - -mipac.manager.reaction module ------------------------------ - -.. automodule:: mipac.manager.reaction - :members: - :undoc-members: - :show-inheritance: - -mipac.manager.user module -------------------------- - -.. automodule:: mipac.manager.user - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: mipac.manager - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/mipac.models.rst b/docs/mipac.models.rst deleted file mode 100644 index b3e7fdf..0000000 --- a/docs/mipac.models.rst +++ /dev/null @@ -1,93 +0,0 @@ -mipac.models package -==================== - -Submodules ----------- - -mipac.models.channel module ---------------------------- - -.. automodule:: mipac.models.channel - :members: - :undoc-members: - :show-inheritance: - -mipac.models.chat module ------------------------- - -.. attributetable:: mipac.models.chat - :members: - :undoc-members: - :show-inheritance: - -mipac.models.drive module -------------------------- - -.. automodule:: mipac.models.drive - :members: - :undoc-members: - :show-inheritance: - -mipac.models.emoji module -------------------------- - -.. automodule:: mipac.models.emoji - :members: - :undoc-members: - :show-inheritance: - -mipac.models.follow module --------------------------- - -.. automodule:: mipac.models.follow - :members: - :undoc-members: - :show-inheritance: - -mipac.models.instance module ----------------------------- - -.. automodule:: mipac.models.instance - :members: - :undoc-members: - :show-inheritance: - -mipac.models.note module ------------------------- - -.. automodule:: mipac.models.note - :members: - :undoc-members: - :show-inheritance: - -mipac.models.notification module --------------------------------- - -.. automodule:: mipac.models.notification - :members: - :undoc-members: - :show-inheritance: - -mipac.models.poll module ------------------------- - -.. automodule:: mipac.models.poll - :members: - :undoc-members: - :show-inheritance: - -mipac.models.user module ------------------------- - -.. automodule:: mipac.models.user - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: mipac.models - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/mipac.rst b/docs/mipac.rst deleted file mode 100644 index e24e683..0000000 --- a/docs/mipac.rst +++ /dev/null @@ -1,66 +0,0 @@ -mipac package -============= - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - mipac.abc - mipac.actions - mipac.core - mipac.manager - mipac.models - mipac.types - -Submodules ----------- - -mipac.client module -------------------- - -.. automodule:: mipac.client - :members: - :undoc-members: - :show-inheritance: - -mipac.config module -------------------- - -.. automodule:: mipac.config - :members: - :undoc-members: - :show-inheritance: - -mipac.exception module ----------------------- - -.. automodule:: mipac.exception - :members: - :undoc-members: - :show-inheritance: - -mipac.http module ------------------ - -.. automodule:: mipac.http - :members: - :undoc-members: - :show-inheritance: - -mipac.util module ------------------ - -.. automodule:: mipac.util - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: mipac - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/mipac.types.rst b/docs/mipac.types.rst deleted file mode 100644 index 719fca9..0000000 --- a/docs/mipac.types.rst +++ /dev/null @@ -1,133 +0,0 @@ -mipac.types package -=================== - -Submodules ----------- - -mipac.types.ads module ----------------------- - -.. automodule:: mipac.types.ads - :members: - :undoc-members: - :show-inheritance: - -mipac.types.channel module --------------------------- - -.. automodule:: mipac.types.channel - :members: - :undoc-members: - :show-inheritance: - -mipac.types.chart module ------------------------- - -.. automodule:: mipac.types.chart - :members: - :undoc-members: - :show-inheritance: - -mipac.types.chat module ------------------------ - -.. automodule:: mipac.types.chat - :members: - :undoc-members: - :show-inheritance: - -mipac.types.drive module ------------------------- - -.. automodule:: mipac.types.drive - :members: - :undoc-members: - :show-inheritance: - -mipac.types.emoji module ------------------------- - -.. automodule:: mipac.types.emoji - :members: - :undoc-members: - :show-inheritance: - -mipac.types.endpoints module ----------------------------- - -.. automodule:: mipac.types.endpoints - :members: - :undoc-members: - :show-inheritance: - -mipac.types.follow module -------------------------- - -.. automodule:: mipac.types.follow - :members: - :undoc-members: - :show-inheritance: - -mipac.types.instance module ---------------------------- - -.. automodule:: mipac.types.instance - :members: - :undoc-members: - :show-inheritance: - -mipac.types.note module ------------------------ - -.. automodule:: mipac.types.note - :members: - :undoc-members: - :show-inheritance: - -mipac.types.notification module -------------------------------- - -.. automodule:: mipac.types.notification - :members: - :undoc-members: - :show-inheritance: - -mipac.types.page module ------------------------ - -.. automodule:: mipac.types.page - :members: - :undoc-members: - :show-inheritance: - -mipac.types.poll module ------------------------ - -.. automodule:: mipac.types.poll - :members: - :undoc-members: - :show-inheritance: - -mipac.types.reaction module ---------------------------- - -.. automodule:: mipac.types.reaction - :members: - :undoc-members: - :show-inheritance: - -mipac.types.user module ------------------------ - -.. automodule:: mipac.types.user - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: mipac.types - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/modules.rst b/docs/modules.rst deleted file mode 100644 index cb01b1c..0000000 --- a/docs/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -mipaaa -====== - -.. toctree:: - :maxdepth: 4 - - main diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index fce70d7..0000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,5 +0,0 @@ -sphinx -furo -sphinxcontrib_trio -aiohttp -