Skip to content

Commit 5480b69

Browse files
committed
init
1 parent 03786ab commit 5480b69

File tree

7 files changed

+330
-0
lines changed

7 files changed

+330
-0
lines changed

.gitignore

+163
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
# Created by https://www.toptal.com/developers/gitignore/api/python,visualstudiocode
2+
# Edit at https://www.toptal.com/developers/gitignore?templates=python,visualstudiocode
3+
4+
### Python ###
5+
# Byte-compiled / optimized / DLL files
6+
__pycache__/
7+
*.py[cod]
8+
*$py.class
9+
10+
# C extensions
11+
*.so
12+
13+
# Distribution / packaging
14+
.Python
15+
build/
16+
develop-eggs/
17+
dist/
18+
downloads/
19+
eggs/
20+
.eggs/
21+
lib/
22+
lib64/
23+
parts/
24+
sdist/
25+
var/
26+
wheels/
27+
share/python-wheels/
28+
*.egg-info/
29+
.installed.cfg
30+
*.egg
31+
MANIFEST
32+
33+
# PyInstaller
34+
# Usually these files are written by a python script from a template
35+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
36+
*.manifest
37+
*.spec
38+
39+
# Installer logs
40+
pip-log.txt
41+
pip-delete-this-directory.txt
42+
43+
# Unit test / coverage reports
44+
htmlcov/
45+
.tox/
46+
.nox/
47+
.coverage
48+
.coverage.*
49+
.cache
50+
nosetests.xml
51+
coverage.xml
52+
*.cover
53+
*.py,cover
54+
.hypothesis/
55+
.pytest_cache/
56+
cover/
57+
58+
# Translations
59+
*.mo
60+
*.pot
61+
62+
# Django stuff:
63+
*.log
64+
local_settings.py
65+
db.sqlite3
66+
db.sqlite3-journal
67+
68+
# Flask stuff:
69+
instance/
70+
.webassets-cache
71+
72+
# Scrapy stuff:
73+
.scrapy
74+
75+
# PyBuilder
76+
.pybuilder/
77+
target/
78+
79+
# Jupyter Notebook
80+
.ipynb_checkpoints
81+
82+
# IPython
83+
profile_default/
84+
ipython_config.py
85+
86+
# pyenv
87+
# For a library or package, you might want to ignore these files since the code is
88+
# intended to run in multiple environments; otherwise, check them in:
89+
# .python-version
90+
91+
# pipenv
92+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
93+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
94+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
95+
# install all needed dependencies.
96+
#Pipfile.lock
97+
98+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
99+
__pypackages__/
100+
101+
# Celery stuff
102+
celerybeat-schedule
103+
celerybeat.pid
104+
105+
# SageMath parsed files
106+
*.sage.py
107+
108+
# Environments
109+
.env
110+
.venv
111+
env/
112+
venv/
113+
ENV/
114+
env.bak/
115+
venv.bak/
116+
117+
# Spyder project settings
118+
.spyderproject
119+
.spyproject
120+
121+
# Rope project settings
122+
.ropeproject
123+
124+
# mkdocs documentation
125+
/site
126+
127+
# mypy
128+
.mypy_cache/
129+
.dmypy.json
130+
dmypy.json
131+
132+
# Pyre type checker
133+
.pyre/
134+
135+
# pytype static type analyzer
136+
.pytype/
137+
138+
# Cython debug symbols
139+
cython_debug/
140+
141+
### VisualStudioCode ###
142+
.vscode
143+
# .vscode/*
144+
# !.vscode/settings.json
145+
# !.vscode/tasks.json
146+
# !.vscode/launch.json
147+
# !.vscode/extensions.json
148+
*.code-workspace
149+
150+
# Local History for Visual Studio Code
151+
.history/
152+
153+
### VisualStudioCode Patch ###
154+
# Ignore all local history of files
155+
.history
156+
.ionide
157+
158+
# Support for Project snippet scope
159+
!.vscode/*.code-snippets
160+
161+
# End of https://www.toptal.com/developers/gitignore/api/python,visualstudiocode
162+
163+
.pdm.toml

.prettierignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.md

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# nb-autodoc
2+
3+
API doc generation for NoneBot.

mypy.ini

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[mypy]
2+
ignore_missing_imports = True
3+
disallow_untyped_defs = True

nb_autodoc/__init__.py

Whitespace-only changes.

pdm.lock

+131
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
[project]
2+
name = "nb-autodoc"
3+
version = "0.1.0"
4+
description = "API doc generation for NoneBot."
5+
authors = [
6+
{name = "iyume", email = "[email protected]"},
7+
]
8+
dependencies = [
9+
"mako~=1.1",
10+
"markdown>=3.0",
11+
]
12+
requires-python = ">=3.9"
13+
license = {text = "MIT"}
14+
readme = "README.md"
15+
keywords = ["nonebot", "autodoc"]
16+
17+
[project.urls]
18+
homepage = "https://github.com/nonebot/nb-autodoc"
19+
repository = "https://github.com/nonebot/nb-autodoc"
20+
documentation = "https://github.com/nonebot/nb-autodoc/blob/master/README.md"
21+
22+
[tool.black]
23+
line-length = 88
24+
25+
[tool.pdm]
26+
27+
[build-system]
28+
requires = ["pdm-pep517"]
29+
build-backend = "pdm.pep517.api"

0 commit comments

Comments
 (0)