kaxil commented on code in PR #75001: URL: https://github.com/apache/airflow/pull/75001#discussion_r4360905621
########## contributing-docs/11_documentation_building.rst: ########## @@ -241,6 +241,17 @@ For example: Will build ``fab`` provider documentation and clean build artifacts before. +To try a change to the HTML theme (``sphinx_airflow_theme`` from the +`airflow-site <https://github.com/apache/airflow-site>`_ repository) on real documentation, build with the +theme folder of an ``airflow-site`` checkout instead of the published wheel: + +.. code-block:: bash + + breeze build-docs apache-airflow --sphinx-airflow-theme-path ../airflow-site/sphinx_airflow_theme + +Run ``./site.sh prepare-theme`` in ``airflow-site`` first to generate the theme's CSS/JS. Breeze mounts the Review Comment: `prepare-theme` only runs `yarn run build` when `landing-pages/dist/index.html` is missing, then copies whatever is already in `dist` into `_gen`. So on a checkout that has been built once, editing the SCSS/JS and re-running `prepare-theme` copies the old bundle and the docs build shows the unchanged CSS. The README in apache/airflow-site#1691 already says to run `./site.sh build-landing-pages` first. Could this line, the `--sphinx-airflow-theme-path` help text and the `BadParameter` message say `./site.sh build-landing-pages && ./site.sh prepare-theme`? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
