![]() ![]() High-level documentation about the provider's service.The README for your provider package should give users an overview of what your provider package does. A declarative definition of parameters that you can pass to the module, templated per the example below.įor a full example of inline module documentation, see the example operator in this repository.For more information Sphinx markdown directives, read the Sphinx documentation. This can include details such as code blocks or blockquotes. A longer description explaining how the module works.A one-sentence description explaining what the module does.These docstrings should be included at the top of each module file and contain three sections separated by blank lines: Inline Module DocumentationĮvery Python module, including all hooks, operators, sensors, and transfers, should be documented inline via sphinx-templated docstrings. Documentation StandardsĬreating excellent documentation is essential for explaining the purpose of your provider package and how to use it. ![]() To connect custom links to Airflow, add the operator class name to "extra-links" in the get_provider_info method mentioned above. format ( example = 'example' ) class ExampleOperator ( BaseOperator ): """ExampleOperator docstring.""" operator_extra_links = ( Example Link (),) At the lower bound, specify minor versions (for example, depx >=2.0.0, Dict : """Returns connection widgets to add to connection form""" from flask_appbuilder.fieldwidgets import BS3PasswordFieldWidget, BS3TextFieldWidget from flask_babel import lazy_gettext from wtforms import PasswordField, StringField, BooleanField return.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |