Packaging a project¶
In this section, you will learn how to build your project documentation, as well as how to bundle your project into a Python package for handover.
Add documentation to your project¶
While Kedro documentation can be found by running kedro docs
from the command line, project-specific documentation can be generated by running kedro build-docs
in the project’s root directory.
This will create documentation based on the code structure of your project. Documentation will also include the docstrings
defined in the project code. The resulting HTML files can be found in docs/build/html/
.
kedro build-docs
uses the Sphinx framework to build your project documentation, so if you want to customise it, please refer to docs/source/conf.py
and the corresponding section of the Sphinx documentation.
Package your project¶
You can package your project by running kedro package
from the command line. This will create one .egg
file and one .whl
file within the src/dist/
folder of your project, which are Python packaging formats. For further information about packaging for Python, documentation is provided here.
What is next?¶
You have now successfully built a project along with its documentation and packaged it using one of standard Python distribution formats. You may choose to open-source your project and make it available to a wider community of users and contributors. For further steps we advise you to consult this GitHub guide, PyPI help, a Read the Docs tutorial, and a guide to Open Source Licenses & Standards.