Skip to content

Commit

Permalink
docs: Move all images out of the repo
Browse files Browse the repository at this point in the history
Change-Id: I28dda5737c1a99f5ca8de80ea06f2ebcb25db8cb
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/176751
Reviewed-by: Kayce Basques <[email protected]>
Presubmit-Verified: CQ Bot Account <[email protected]>
Commit-Queue: Kayce Basques <[email protected]>
  • Loading branch information
tpudlik authored and CQ Bot Account committed Oct 20, 2023
1 parent f8ab5df commit 2fa492e
Show file tree
Hide file tree
Showing 12 changed files with 11 additions and 22 deletions.
7 changes: 0 additions & 7 deletions docs/BUILD.gn
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,6 @@ pw_doc_group("core_docs") {
"$dir_pw_build/py/pw_build/generate_python_wheel_cache.py",
"$dir_pw_build/python.gni",
"$dir_pw_build/python_gn_args.gni",
"images/pw_env_setup_demo.gif",
"images/pw_status_test.png",
"images/pw_watch_build_demo.gif",
"images/pw_watch_on_device_demo.gif",
"images/pw_watch_test_demo.gif",
"images/pw_watch_test_demo2.gif",
"images/stm32f429i-disc1_connected.jpg",
"layout/page.html",
"run_doxygen.py",
]
Expand Down
10 changes: 5 additions & 5 deletions docs/get_started/upstream.rst
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ bootstrap may take several minutes to complete, so please be patient.
Below is a real-time demo with roughly what you should expect to see as output:

.. image:: ../images/pw_env_setup_demo.gif
.. image:: https://storage.googleapis.com/pigweed-media/pw_env_setup_demo.gif
:width: 800
:alt: build example using pw watch

Expand Down Expand Up @@ -260,7 +260,7 @@ save the file.

See below for a demo of this in action:

.. image:: ../images/pw_watch_build_demo.gif
.. image:: https://storage.googleapis.com/pigweed-media/pw_watch_build_demo.gif
:width: 800
:alt: build example using pw watch

Expand All @@ -274,7 +274,7 @@ failure.
To see a test failure, modify ``pw_status/status_test.cc`` to fail by changing
one of the strings in the "KnownString" test.

.. image:: ../images/pw_watch_test_demo.gif
.. image:: https://storage.googleapis.com/pigweed-media/pw_watch_test_demo.gif
:width: 800
:alt: example test failure using pw watch

Expand Down Expand Up @@ -330,7 +330,7 @@ updates to ensure you have permissions to use the USB device. For example, on
Linux you may need to update your udev rules and ensure you're in the plugdev
and dialout groups.

.. image:: ../images/stm32f429i-disc1_connected.jpg
.. image:: https://storage.googleapis.com/pigweed-media/stm32f429i-disc1_connected.jpg
:width: 800
:alt: development boards connected via USB

Expand Down Expand Up @@ -367,7 +367,7 @@ will be run across the attached boards!

See the demo below for an example of what this all looks like put together:

.. image:: ../images/pw_watch_on_device_demo.gif
.. image:: https://storage.googleapis.com/pigweed-media/pw_watch_on_device_demo.gif
:width: 800
:alt: pw watch running on-device tests

Expand Down
Binary file removed docs/images/pw_env_setup_demo.gif
Binary file not shown.
Binary file removed docs/images/pw_status_test.png
Binary file not shown.
Binary file removed docs/images/pw_watch_build_demo.gif
Binary file not shown.
Binary file removed docs/images/pw_watch_on_device_demo.gif
Binary file not shown.
Binary file removed docs/images/pw_watch_test_demo.gif
Binary file not shown.
Binary file removed docs/images/pw_watch_test_demo2.gif
Binary file not shown.
Binary file removed docs/images/stm32f429i-disc1_connected.jpg
Binary file not shown.
8 changes: 4 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ and verifying the test runs as expected. Once this is set up, you can attach
multiple devices to run tests in a distributed manner to reduce the time it
takes to run tests.

.. image:: docs/images/pw_watch_on_device_demo.gif
.. image:: https://storage.googleapis.com/pigweed-media/pw_watch_on_device_demo.gif
:width: 800
:alt: pw watch running on-device tests

Expand All @@ -111,7 +111,7 @@ With ``pw format``, you can format C, C++, Python, GN, and Go code according to
configurations defined by your project. ``pw format`` leverages existing tools
like ``clang-format``, and it’s simple to add support for new languages.

.. image:: pw_presubmit/docs/pw_presubmit_demo.gif
.. image:: https://storage.googleapis.com/pigweed-media/pw_presubmit_demo.gif
:width: 800
:alt: pw presubmit demo

Expand Down Expand Up @@ -142,7 +142,7 @@ turn inflates a virtual environment. The tooling is installed into your
workspace, and makes no changes to your system. This tooling is designed to be
reused by any project.

.. image:: docs/images/pw_env_setup_demo.gif
.. image:: https://storage.googleapis.com/pigweed-media/pw_env_setup_demo.gif
:width: 800
:alt: pw environment setup demo

Expand All @@ -162,7 +162,7 @@ build, the result is a flexible and powerful setup that enables easily
developing code on your desktop (with tests), then running the same tests
on-device.

.. image:: docs/images/pw_status_test.png
.. image:: https://storage.googleapis.com/pigweed-media/pw_status_test.png
:width: 800
:alt: pw_status test run natively on host

Expand Down
4 changes: 0 additions & 4 deletions pw_watch/BUILD.gn
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,6 @@ import("$dir_pw_docgen/docs.gni")
import("$dir_pw_unit_test/test.gni")

pw_doc_group("docs") {
inputs = [
"doc_resources/pw_watch_on_device_demo.gif",
"doc_resources/pw_watch_test_demo2.gif",
]
sources = [
"cli.rst",
"docs.rst",
Expand Down
4 changes: 2 additions & 2 deletions pw_watch/docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Our solution
tooling but is focused around embedded development use cases. After changing
source code, ``pw_watch`` can instantly compile, flash, and run tests.

.. figure:: doc_resources/pw_watch_test_demo2.gif
.. figure:: https://storage.googleapis.com/pigweed-media/pw_watch_test_demo2.gif
:width: 1420
:alt: ``pw watch`` running in fullscreen mode and displaying errors

Expand All @@ -46,7 +46,7 @@ and verifying the test runs as expected. Once this is set up, you can attach
multiple devices to run tests in a distributed manner to reduce the time it
takes to run tests.

.. image:: doc_resources/pw_watch_on_device_demo.gif
.. figure:: https://storage.googleapis.com/pigweed-media/pw_watch_on_device_demo.gif
:width: 800
:alt: pw_watch running on-device tests

Expand Down

0 comments on commit 2fa492e

Please sign in to comment.