mirror of https://github.com/yupix/mipac
yupix
2 years ago
parent
0a0a7fe389
commit
8910122710
@ -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)
|
||||
@ -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']
|
||||
@ -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
|
||||
@ -1,7 +0,0 @@
|
||||
main module
|
||||
===========
|
||||
|
||||
.. automodule:: main
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -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
|
||||
@ -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:
|
||||
@ -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:
|
||||
@ -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:
|
||||
@ -1,18 +0,0 @@
|
||||
mipac.core package
|
||||
==================
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
mipac.core.models
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: mipac.core
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -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:
|
||||
@ -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:
|
||||
@ -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:
|
||||
@ -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:
|
||||
@ -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:
|
||||
@ -1,7 +0,0 @@
|
||||
mipaaa
|
||||
======
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
main
|
||||
@ -1,5 +0,0 @@
|
||||
sphinx
|
||||
furo
|
||||
sphinxcontrib_trio
|
||||
aiohttp
|
||||
|
||||
Loading…
Reference in new issue