diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index e4f1d08c5d6..5102d67b376 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -96,7 +96,7 @@ jobs: GITHUB_COMMIT: ${{ github.sha }} GITHUB_REF: ${{ github.ref }} if: > - github.ref == 'refs/heads/master' && github.repository == 'apache/airflow' && + github.ref == 'refs/heads/master' && github.repository == 'apache/airflow-site' && github.event_name == 'push' run: | gh auth status diff --git a/sphinx_airflow_theme/README.md b/sphinx_airflow_theme/README.md index bcd95624ef0..8e7ba7794c1 100644 --- a/sphinx_airflow_theme/README.md +++ b/sphinx_airflow_theme/README.md @@ -20,25 +20,40 @@ Sphinx theme for Airflow ======================== -Sphinx theme for Apache Airflow website. +Sphinx theme for Apache Airflow documentation. -# Getting started +# Install from sources In order to start working with the theme, please follow the instructions below. -1. Make sure that your `python` shell command executes Python3 interpreter. If necessary, use a virtual environment: - `mkvirtualenv -p python3 ` +1. Make sure your `python` shell command executes Python3 interpreter. If necessary, use a virtual environment: + ``` + mkvirtualenv -p python3 ` + ``` 2. To make Javascript and CSS code available for the theme, run the following command in the root directory: - - `./site.sh build-site && ./site.sh prepare-theme` + ``` + ./site.sh build-site && ./site.sh prepare-theme + ``` 3. To install the required Python packages, in `/sphinx_airflow_theme` run: - - `pip install -e .` + ``` + pip install -e . + ``` 4. To launch the demo documentation page, in `/sphinx_airflow_theme/demo` run: - `./docs.sh build && ./docs.sh preview` + ``` + ./docs.sh build && ./docs.sh preview` + ``` + +# Install developer version + +To install the latest development version of a theme, run: +``` +pip install 'https://github.com/PolideaInternal/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. # Theme's source files