feat(docs): Added more documentation on plugins
This commit is contained in:
parent
e510c54bd8
commit
2f4472e708
|
@ -67,7 +67,8 @@ instance/
|
||||||
|
|
||||||
# Sphinx documentation
|
# Sphinx documentation
|
||||||
docs/_build/
|
docs/_build/
|
||||||
docs/
|
# pdoc
|
||||||
|
docs/html
|
||||||
|
|
||||||
# PyBuilder
|
# PyBuilder
|
||||||
target/
|
target/
|
||||||
|
|
|
@ -0,0 +1,13 @@
|
||||||
|
# Plugin Development
|
||||||
|
|
||||||
|
## File Structure
|
||||||
|
|
||||||
|
- your_plugin/
|
||||||
|
- __init__.py
|
||||||
|
- ...
|
||||||
|
- ...
|
||||||
|
- setup.cfg
|
||||||
|
|
||||||
|
The basic layout of a plugin is quite simple, you will only need the `setup.cfg` or `setup.py` and
|
||||||
|
the package containing your plugin code, at lease a `__init__.py` file with your `Plugin` class.
|
||||||
|
|
|
@ -8,7 +8,7 @@ import subprocess
|
||||||
"--output",
|
"--output",
|
||||||
"-o",
|
"-o",
|
||||||
help="Documentation output path",
|
help="Documentation output path",
|
||||||
default="./docs",
|
default="./docs/html",
|
||||||
type=click.Path(file_okay=False, path_type=pathlib.Path),
|
type=click.Path(file_okay=False, path_type=pathlib.Path),
|
||||||
)
|
)
|
||||||
@click.pass_context
|
@click.pass_context
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
"""Flaschengeist Plugins
|
||||||
|
|
||||||
|
.. include:: docs/plugin_development.md
|
||||||
|
|
||||||
|
"""
|
||||||
import pkg_resources
|
import pkg_resources
|
||||||
from werkzeug.datastructures import FileStorage
|
from werkzeug.datastructures import FileStorage
|
||||||
from werkzeug.exceptions import MethodNotAllowed, NotFound
|
from werkzeug.exceptions import MethodNotAllowed, NotFound
|
||||||
|
|
Loading…
Reference in New Issue