[Documentation] Adds Sphnix-copy-button & sphnix-tabs to docs

[davinci26]

Signed-off-by: Sotiris Nanopoulos sonanopo@microsoft.com

Fixes #13213

Major changes:

1. Code snippets now have a copy button
2. We add support for tabs in the documentation.

Additional Description:
This is how it looks now.

refs:

1. https://sphinx-copybutton.readthedocs.io/en/latest/
2. https://github.com/executablebooks/sphinx-tabs

Risk Level: Low
Testing: Manually
Docs Changes: N/A
Release Notes: N/A

[repokitteh-read-only]

CC @envoyproxy/dependency-watchers: FYI only for changes made to (bazel/repository_locations\.bzl)|(api/bazel/repository_locations\.bzl)|(.*/requirements\.txt).

🐱

Caused by: #13239 was opened by davinci26.

see: more, trace.

[davinci26]

@phlax let me know what you think.

cc: @envoyproxy/windows-dev this should be useful for Windows vs POSIX documentation.

[phlax]

Overall, looks great - i think ssh should be first tho.

Nice one for throwing in copybutton i was looking at that earlier and wondering

It might be easier waiting till #13230 has landed - just in terms of making changes - but im happy to rebase if necessary - defo not a blocker

[phlax]

im thinking we probably want ssh first on the basis that most people following these instructions are devs and have a github acc

[davinci26]

I just did it that way because of GitHub. But it makes sense for us to have them the opposite way. I will change that.

[phlax]

is it easy/possible to disable copybutton for some blocks ?

for the interactive console stuff it makes less sense - brilliant for config tho!

[phlax]

...interactive console stuff it makes less sense

maybe im wrong about that - ideal would be that you can copy single lines i think (and perhaps link to them) - not sure how plugin works

[davinci26]

is it easy/possible to disable copybutton for some blocks ?

I added the regex for bash so it is actually pretty smart. For example in the Cache Filter it works in the following way:

Snippet:

 $ pwd
envoy/examples/cache
 $ docker-compose build --pull
 $ docker-compose up -d
 $ docker-compose ps

       Name                      Command            State                             Ports
------------------------------------------------------------------------------------------------------------------------
cache_front-envoy_1   /docker-entrypoint.sh /bin ... Up      10000/tcp, 0.0.0.0:8000->8000/tcp, 0.0.0.0:8001->8001/tcp
cache_service1_1      /bin/sh -c /usr/local/bin/ ... Up      10000/tcp, 8000/tcp
cache_service2_1      /bin/sh -c /usr/local/bin/ ... Up      10000/tcp, 8000/tcp

The pasted output is:

pwd
docker-compose build --pull
docker-compose up -d
docker-compose ps

[phlax]

yep - thats pretty cool

[davinci26]

re: rebase after #13230, I also dont mind rebasing. It is the same for me.

[phlax]

@davinci26 not sure why the test failed (ran out of disk space) - i dont think its because of changes in your PR (might be wrong).

either way - its hung the test instance - adding an empty commit would kick the ci and i think kill the dead server instance

[davinci26]

@phlax i think it is a known issue with gcc in the CI #13212

[davinci26]

/retest

[repokitteh-read-only]

Retrying Azure Pipelines, to retry CircleCI checks, use /retest-circle.
Retried failed jobs in: envoy-presubmit

🐱

Caused by: a #13239 (comment) was created by @davinci26.

see: more, trace.

[mattklein123]

Neat, I will just force merge this while we sort out unrelated CI issues.