Sphinx theme for Apache Airflow documentation.
In order to start working with the theme, please follow the instructions below.
Make sure your
python shell command executes Python3 interpreter. If necessary, use a virtual environment:
mkvirtualenv -p python3 <name_of_environment>
./site.sh build-site && ./site.sh prepare-theme
To install the required Python packages, in
<ROOT DIRECTORY>/sphinx_airflow_theme run:
pip install -e .
To launch the demo documentation page, in
<ROOT DIRECTORY>/sphinx_airflow_theme/demo run:
./docs.sh build && ./docs.sh preview
To install the latest development version of a theme, run:
pip install 'https://github.com/apache/airflow-site/releases/download/v0.0.1/sphinx_airflow_theme-0.0.1-py3-none-any.whl'
Python packages for your PRs is available as downloadable artifact in GitHub Actions after the CI builds your PR.
<ROOT DIRECTORY>/sphinx_airflow_theme/sphinx_airflow_theme- HTML files
<ROOT DIRECTORY>/landing-pages/site/assets/scss- SCSS files