mirror of
https://github.com/nonebot/nonebot2.git
synced 2025-07-30 09:40:05 +00:00
🔥remove sphinx
This commit is contained in:
hemengyang
@ -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,12 +0,0 @@
|
||||
\-\-\-
|
||||
sidebar_position: 1
|
||||
id: index
|
||||
slug: /api
|
||||
\-\-\-
|
||||
|
||||
NoneBot 模块
|
||||
===============
|
||||
|
||||
.. automodule:: nonebot
|
||||
:members:
|
||||
:show-inheritance:
|
||||
@ -1,43 +0,0 @@
|
||||
\-\-\-
|
||||
id: index
|
||||
slug: /api/adapters/
|
||||
\-\-\-
|
||||
|
||||
NoneBot.adapters 模块
|
||||
=====================
|
||||
|
||||
.. automodule:: nonebot.adapters
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members: __init__
|
||||
:show-inheritance:
|
||||
|
||||
.. automodule:: nonebot.adapters._adapter
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members: __init__
|
||||
:show-inheritance:
|
||||
|
||||
.. automodule:: nonebot.adapters._bot
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members: __init__
|
||||
:show-inheritance:
|
||||
|
||||
.. automodule:: nonebot.adapters._message
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members: __init__
|
||||
:show-inheritance:
|
||||
|
||||
.. automodule:: nonebot.adapters._event
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members: __init__
|
||||
:show-inheritance:
|
||||
|
||||
.. automodule:: nonebot.adapters._template
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members: __init__
|
||||
:show-inheritance:
|
||||
@ -1,82 +0,0 @@
|
||||
# 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(os.path.dirname(os.path.dirname(__file__))))
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'nonebot'
|
||||
copyright = '2020, richardchien'
|
||||
author = 'richardchien'
|
||||
|
||||
# The short X.Y version
|
||||
version = '2.0.0'
|
||||
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = '2.0.0'
|
||||
|
||||
# -- 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 = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.viewcode',
|
||||
'sphinx.ext.todo',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#
|
||||
# This is also used if you do content translation via gettext catalogs.
|
||||
# Usually you set "language" from the command line for these cases.
|
||||
language = 'zh_CN'
|
||||
|
||||
master_doc = "README"
|
||||
|
||||
# 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 = ['_build', 'Thumbs.db', '.DS_Store']
|
||||
|
||||
# -- 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 = 'alabaster'
|
||||
|
||||
# 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_baseurl = '/api/'
|
||||
|
||||
# -- Extension configuration -------------------------------------------------
|
||||
|
||||
# -- Options for autodoc extension ----------------------------------------------
|
||||
autodoc_default_options = {'member-order': 'bysource'}
|
||||
autodoc_inherit_docstrings = False
|
||||
autodoc_typehints = 'none'
|
||||
|
||||
# -- Options for todo extension ----------------------------------------------
|
||||
|
||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||
todo_include_todos = True
|
||||
@ -1,10 +0,0 @@
|
||||
\-\-\-
|
||||
sidebar_position: 2
|
||||
\-\-\-
|
||||
|
||||
NoneBot.config 模块
|
||||
===================
|
||||
|
||||
.. automodule:: nonebot.config
|
||||
:members: Env, Config
|
||||
:show-inheritance:
|
||||
@ -1,11 +0,0 @@
|
||||
\-\-\-
|
||||
sidebar_position: 8
|
||||
\-\-\-
|
||||
|
||||
NoneBot.dependencies 模块
|
||||
====================
|
||||
|
||||
.. automodule:: nonebot.dependencies
|
||||
:members:
|
||||
:private-members:
|
||||
:show-inheritance:
|
||||
@ -1,13 +0,0 @@
|
||||
\-\-\-
|
||||
id: index
|
||||
slug: /api/drivers/
|
||||
\-\-\-
|
||||
|
||||
NoneBot.drivers 模块
|
||||
=====================
|
||||
|
||||
.. automodule:: nonebot.drivers
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members: __init__
|
||||
:show-inheritance:
|
||||
@ -1,9 +0,0 @@
|
||||
|
||||
|
||||
NoneBot.drivers.aiohttp 模块
|
||||
=============================
|
||||
|
||||
.. automodule:: nonebot.drivers.aiohttp
|
||||
:members:
|
||||
:private-members:
|
||||
:show-inheritance:
|
||||
@ -1,9 +0,0 @@
|
||||
|
||||
|
||||
NoneBot.drivers.fastapi 模块
|
||||
=============================
|
||||
|
||||
.. automodule:: nonebot.drivers.fastapi
|
||||
:members:
|
||||
:private-members:
|
||||
:show-inheritance:
|
||||
@ -1,9 +0,0 @@
|
||||
|
||||
|
||||
NoneBot.drivers.httpx 模块
|
||||
=============================
|
||||
|
||||
.. automodule:: nonebot.drivers.httpx
|
||||
:members:
|
||||
:private-members:
|
||||
:show-inheritance:
|
||||
@ -1,9 +0,0 @@
|
||||
|
||||
|
||||
NoneBot.drivers.quart 模块
|
||||
==========================
|
||||
|
||||
.. automodule:: nonebot.drivers.quart
|
||||
:members:
|
||||
:private-members:
|
||||
:show-inheritance:
|
||||
@ -1,9 +0,0 @@
|
||||
|
||||
|
||||
NoneBot.drivers.websockets 模块
|
||||
=============================
|
||||
|
||||
.. automodule:: nonebot.drivers.websockets
|
||||
:members:
|
||||
:private-members:
|
||||
:show-inheritance:
|
||||
@ -1,10 +0,0 @@
|
||||
\-\-\-
|
||||
sidebar_position: 12
|
||||
\-\-\-
|
||||
|
||||
NoneBot.exception 模块
|
||||
======================
|
||||
|
||||
.. automodule:: nonebot.exception
|
||||
:members:
|
||||
:show-inheritance:
|
||||
@ -1,10 +0,0 @@
|
||||
\-\-\-
|
||||
sidebar_position: 9
|
||||
\-\-\-
|
||||
|
||||
NoneBot.log 模块
|
||||
=================
|
||||
|
||||
.. automodule:: nonebot.log
|
||||
: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
|
||||
|
||||
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
|
||||
@ -1,12 +0,0 @@
|
||||
\-\-\-
|
||||
sidebar_position: 5
|
||||
\-\-\-
|
||||
|
||||
NoneBot.matcher 模块
|
||||
====================
|
||||
|
||||
.. automodule:: nonebot.matcher
|
||||
:members:
|
||||
:private-members:
|
||||
:special-members: __init__
|
||||
:show-inheritance:
|
||||
@ -1,10 +0,0 @@
|
||||
\-\-\-
|
||||
sidebar_position: 4
|
||||
\-\-\-
|
||||
|
||||
NoneBot.message 模块
|
||||
======================
|
||||
|
||||
.. automodule:: nonebot.message
|
||||
:members:
|
||||
:show-inheritance:
|
||||
@ -1,11 +0,0 @@
|
||||
\-\-\-
|
||||
sidebar_position: 7
|
||||
\-\-\-
|
||||
|
||||
NoneBot.permission 模块
|
||||
=======================
|
||||
|
||||
.. automodule:: nonebot.permission
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:special-members:
|
||||
@ -1,31 +0,0 @@
|
||||
\-\-\-
|
||||
sidebar_position: 3
|
||||
\-\-\-
|
||||
|
||||
NoneBot.plugin 模块
|
||||
====================
|
||||
|
||||
.. automodule:: nonebot.plugin
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:special-members: __init__
|
||||
|
||||
.. automodule:: nonebot.plugin.plugin
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:special-members: __init__
|
||||
|
||||
.. automodule:: nonebot.plugin.on
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:special-members: __init__
|
||||
|
||||
.. automodule:: nonebot.plugin.load
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:special-members: __init__
|
||||
|
||||
.. automodule:: nonebot.plugin.export
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:special-members: __init__
|
||||
@ -1,11 +0,0 @@
|
||||
\-\-\-
|
||||
sidebar_position: 6
|
||||
\-\-\-
|
||||
|
||||
NoneBot.rule 模块
|
||||
====================
|
||||
|
||||
.. automodule:: nonebot.rule
|
||||
:members:
|
||||
:special-members:
|
||||
:show-inheritance:
|
||||
@ -1,10 +0,0 @@
|
||||
\-\-\-
|
||||
sidebar_position: 11
|
||||
\-\-\-
|
||||
|
||||
NoneBot.typing 模块
|
||||
===================
|
||||
|
||||
.. automodule:: nonebot.typing
|
||||
:members:
|
||||
:show-inheritance:
|
||||
@ -1,10 +0,0 @@
|
||||
\-\-\-
|
||||
sidebar_position: 10
|
||||
\-\-\-
|
||||
|
||||
NoneBot.utils 模块
|
||||
==================
|
||||
|
||||
.. automodule:: nonebot.utils
|
||||
:members:
|
||||
:show-inheritance:
|
||||
Reference in New Issue
Block a user