docs: Add more guidance to Bazel docgen quickstart

Change-Id: Icfbb5b2c5172c088cf082662a7abed04fb67f979 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/240877 Pigweed-Auto-Submit: Kayce Basques <[email protected]> Reviewed-by: Ted Pudlik <[email protected]> Commit-Queue: Auto-Submit <[email protected]> Lint: Lint 🤖 <[email protected]> Presubmit-Verified: CQ Bot Account <[email protected]>
google · Oct 8, 2024 · 9fe59f4 · 9fe59f4
1 parent 385019a
commit 9fe59f4
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/docs/contributing/docs/quickstart.rst b/docs/contributing/docs/quickstart.rst
@@ -32,6 +32,30 @@ Build the docs
 
  bazelisk build //docs/...
 
+.. _contrib-docs-quickstart-build-tree:
+
+Build the underlying sources directory
+======================================
+Use this command to verify that files are being copied over to
+the expected location:
+
+.. code-block:: console
+
+ bazelisk build //docs:docs/_sources
+
+.. _contrib-docs-quickstart-build-sphinx:
+
+Directly run Sphinx
+===================
+Use this command to mimic directly running ``sphinx-build``
+from a non-Bazel context. For example, you could set a breakpoint
+in your Sphinx extension, then run this command, then step through
+the code with ``pdb``.
+
+.. code-block:: console
+
+ bazelisk run //docs:docs.run
+
 .. _contrib-docs-quickstart-preview:
 
 ---------------------------------