Skip to content

Commit

Permalink
Fix docs (launchers tutorial, sphinx warning) (#433)
Browse files Browse the repository at this point in the history
* Change command to list available exporters

plainbox is not used anymore, but checkbox-cli can still list exporters.

* Fix warning when building docs

When building docs, the following warning appears:

custom-app.rst.rst:100: WARNING: line number spec is out of range(1-13):
'14'

Replacing 14 with 5 to highlight the correct line (CPU nested part)
  • Loading branch information
pieqq committed Apr 26, 2023
1 parent 931e3ea commit 8478716
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
2 changes: 1 addition & 1 deletion checkbox-ng/docs/custom-app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ testing suite from plainbox-provider-snappy.
.. code-block:: none
:caption: unit/test-plan.pxu
:name: test-plan.pxu-with-nested
:emphasize-lines: 14
:emphasize-lines: 5
nested_part:
device-connections-tp
Expand Down
6 changes: 2 additions & 4 deletions checkbox-ng/docs/launcher-tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -430,16 +430,14 @@ replaced with something meaningful, like ``html``.
``unit``

ID of an exporter to use. To get the list of available exporters on your system
run ``$ plainbox dev list exporter``.
run ``$ checkbox-cli list exporter``.

``options``

A list of options that will be supplied to the exporter. Items should be separated by
spaces or commas.

Example:

::
Example::

[exporter:html]
unit = com.canonical.plainbox::html
Expand Down

0 comments on commit 8478716

Please sign in to comment.