docutils-users

[Docutils-users] how to present commandline output

[Glyn D. <gly...@ca...>]

Hi Folks,

I am looking for a a way to include linux commandline output into my
RST/Sphinx documentation.

The issue is with random indentation and line length and while I can
trim the lines it spoils the readability of the output and removing the
indentation completely screws the context. Below is an example of the
kind of thing I would like to include if possible.

Cheers,
Glyn


Name:                                   helloworld-deployment
Namespace:                        default
CreationTimestamp:       Mon, 16 Jul 2018 15:32:11 +1200
Labels:                                 app=helloworld
Annotations:                     deployment.kubernetes.io/revision=2
Selector:                              app=helloworld
Replicas:                              6 desired | 6 updated | 6 total
| 6 available | 0 unavailable
StrategyType:                   RollingUpdate
MinReadySeconds:         20
RollingUpdateStrategy:  1 max unavailable, 1 max surge
Pod Template:
  Labels:  app=helloworld
  Containers:
    helloworld:
    Image:        chelios/helloworld-flask:latest
    Port:         5000/TCP
    Host Port:    0/TCP
    Environment:  <none>
    Mounts:       <none>
  Volumes:        <none>
Conditions:
  Type           Status  Reason
  ----           ------  ------
  Available      True    MinimumReplicasAvailable
  Progressing    True    NewReplicaSetAvailable
OldReplicaSets:  <none>
NewReplicaSet:   helloworld-deployment-5896b9988 (6/6 replicas created)
Events:
  Type    Reason             Age   From                   Message
  ----    ------             ----  ----                   -------
  Normal  ScalingReplicaSet  6m    deployment-controller Scaled up
replica set helloworld-deployment-58d59d965b to 3
  Normal  ScalingReplicaSet  2m    deployment-controller Scaled up
replica set helloworld-deployment-58d59d965b to 6
  Normal  ScalingReplicaSet  2m    deployment-controller Scaled up
replica set helloworld-deployment-5896b9988 to 1
  Normal  ScalingReplicaSet  2m    deployment-controller Scaled down
replica set helloworld-deployment-58d59d965b to 5
  Normal  ScalingReplicaSet  2m    deployment-controller Scaled up
replica set helloworld-deployment-5896b9988 to 2
  Normal  ScalingReplicaSet  2m    deployment-controller Scaled down
replica set helloworld-deployment-58d59d965b to 3
  Normal  ScalingReplicaSet  2m    deployment-controller Scaled up
replica set helloworld-deployment-5896b9988 to 4
  Normal  ScalingReplicaSet  1m    deployment-controller Scaled down
replica set helloworld-deployment-58d59d965b to 1
  Normal  ScalingReplicaSet  1m    deployment-controller Scaled up
replica set helloworld-deployment-5896b9988 to 6
  Normal  ScalingReplicaSet  1m    deployment-controller (combined from
similar events): Scaled down replica set helloworld-deployment-
58d59d965b to 0

Re: [Docutils-users] how to present commandline output

[Guenter M. <mi...@us...>]

On 2018-08-09, Glyn Davies wrote:

> Hi Folks,

> I am looking for a a way to include linux commandline output into my
> RST/Sphinx documentation.

> The issue is with random indentation and line length and while I can
> trim the lines it spoils the readability of the output and removing the
> indentation completely screws the context. Below is an example of the
> kind of thing I would like to include if possible.

The usual way to do this would be a `literal block`__. If the content resides
in an external file, use `include`__ with the "literal" option.
This keeps the formatting as-is and uses a fixed-width font.

As a downside, you will evt. see very long lines (overrunning the page in
LaTeX output, requiring scrolling in HTML). If this is a one-off, you
could manually break overfull lines in the rST source. In HTML, you may
solve this via CSS (separate side-scrolling for a fixed-width
literal-block element).

__ http://docutils.sf.net/docs/user/rst/quickref.html#literal-blocks
__ http://docutils.sf.net/docs/ref/rst/directives.html#including-an-external-document-fragment

`Class arguments`__ may be used to scale down the font size of blocks
with too long lines.

http://docutils.sf.net/docs/ref/rst/directives.html#class

Your example contains line breaks that are probably from the terminal. Maybe
using a full-screen terminal to capture the output helps.


Hope this gets you started,

Günter