This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 8317ed93a5 Updating the README and visuals for breeze build-docs
(#37276)
8317ed93a5 is described below
commit 8317ed93a58900d922ab4ca8da02ed1c6050252c
Author: Amogh Desai <[email protected]>
AuthorDate: Fri Feb 9 20:17:38 2024 +0530
Updating the README and visuals for breeze build-docs (#37276)
---
.../src/airflow_breeze/commands/developer_commands.py | 6 +++++-
docs/README.rst | 13 ++++++-------
2 files changed, 11 insertions(+), 8 deletions(-)
diff --git a/dev/breeze/src/airflow_breeze/commands/developer_commands.py
b/dev/breeze/src/airflow_breeze/commands/developer_commands.py
index 92882a781a..e9eb6290c5 100644
--- a/dev/breeze/src/airflow_breeze/commands/developer_commands.py
+++ b/dev/breeze/src/airflow_breeze/commands/developer_commands.py
@@ -656,7 +656,11 @@ def build_docs(
fix_ownership_using_docker()
if result.returncode == 0:
get_console().print(
- "[info]Start the webserver in breeze and view the built docs at
http://localhost:28080/docs/[/]";
+ "[info]To view the built documentation, you have two options:\n\n"
+ "1. Start the webserver in breeze and access the built docs at "
+ "http://localhost:28080/docs/\n";
+ "2. Alternatively, you can run ./docs/start_docs_server.sh for a
lighter resource option and view"
+ "the built docs at http://localhost:8000";
)
sys.exit(result.returncode)
diff --git a/docs/README.rst b/docs/README.rst
index e16f22499e..d5cddec486 100644
--- a/docs/README.rst
+++ b/docs/README.rst
@@ -162,19 +162,18 @@ Running the Docs Locally
------------------------
After you build the documentation, you can check the formatting, style, and
documentation build at ``http://localhost:28080/docs/``
-by starting a Breeze environment or by running the following command from the
root directory.
-
-You need to have Python installed to run the command:
+by starting a Breeze environment. Alternatively, you can run the following
command from the root directory:
.. code-block:: bash
docs/start_doc_server.sh
+This command requires Python to be installed. This method is lighter on the
system resources as you do not need to
+launch the webserver just to view docs.
-Then, view your docs at ``localhost:8000``. If you use a virtual machine, like
WSL2,
-you need to find the WSL2 machine IP address and replace "0.0.0.0" in your
browser with it. The address looks like
-``http://n.n.n.n:8000``, where n.n.n.n is the IP of the WSL2.
-
+Once the server is running, you can view your documentation at
http://localhost:8000. If you're using a virtual machine
+like WSL2, you'll need to find the IP address of the WSL2 machine and replace
"0.0.0.0" in your browser with it.
+The address will look like http://n.n.n.n:8000, where n.n.n.n is the IP of the
WSL2 machine.
Cross-referencing syntax
========================
