diff options
Diffstat (limited to 'pw_console/docs.rst')
| -rw-r--r-- | pw_console/docs.rst | 26 |
1 files changed, 14 insertions, 12 deletions
diff --git a/pw_console/docs.rst b/pw_console/docs.rst index 0c7ffc3e0..b4f2a19d5 100644 --- a/pw_console/docs.rst +++ b/pw_console/docs.rst @@ -1,12 +1,14 @@ .. _module-pw_console: ----------- +========== pw_console ----------- - -:bdg-primary:`host` -:bdg-secondary:`Python` -:bdg-success:`stable` +========== +.. pigweed-module:: + :name: pw_console + :tagline: Multi-purpose pluggable interactive console for dev & manufacturing + :status: stable + :languages: Python + :code-size-impact: N/A (host) but works best with pw_rpc on device The Pigweed Console provides a Python repl (read eval print loop) using `ptpython`_ and a log message viewer in a single-window terminal based @@ -15,8 +17,9 @@ interface. It is designed to be a replacement for `IPython's embed()`_ function. .. figure:: images/pw_system_boot.png :alt: Pigweed Console screenshot with serial debug log messages. +-------- Features -======== +-------- ``pw_console`` aims to be a complete solution for interacting with hardware devices using :ref:`module-pw_rpc` over a :ref:`module-pw_hdlc` transport. @@ -33,18 +36,18 @@ devices using :ref:`module-pw_rpc` over a :ref:`module-pw_hdlc` transport. - Log viewer with searching and filtering. +------------ Contributing -============ - +------------ - All code submissions to ``pw_console`` require running the :ref:`module-pw_console-testing`. - Commit messages should include a ``Testing:`` line with the steps that were manually run. +------ Guides -====== - +------ .. toctree:: :maxdepth: 1 @@ -54,7 +57,6 @@ Guides testing internals - .. _IPython's embed(): https://ipython.readthedocs.io/en/stable/interactive/reference.html#embedding .. _IPython: https://ipython.readthedocs.io/ .. _prompt_toolkit: https://python-prompt-toolkit.readthedocs.io/ |