From 0ff65c9780d46e422acc426151378cd169c1a6a0 Mon Sep 17 00:00:00 2001 From: David Wilson Date: Thu, 21 Sep 2017 22:22:43 +0530 Subject: [PATCH] docs: Use sphinx-programoutput plugin for preamble_size.py --- dev_requirements.txt | 1 + docs/conf.py | 2 +- docs/docs-requirements.txt | 1 + docs/index.rst | 10 +--------- 4 files changed, 4 insertions(+), 10 deletions(-) create mode 100644 docs/docs-requirements.txt diff --git a/dev_requirements.txt b/dev_requirements.txt index 6332f2ea..aebcabf3 100644 --- a/dev_requirements.txt +++ b/dev_requirements.txt @@ -1,3 +1,4 @@ +-r docs/docs-requirements.txt docker==2.5.1 docker[tls]==2.5.1 pytest-capturelog==0.7 diff --git a/docs/conf.py b/docs/conf.py index 59a46065..d1a5980d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -4,7 +4,7 @@ sys.path.append('..') author = u'David Wilson' copyright = u'2016, David Wilson' exclude_patterns = ['_build'] -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx'] +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinxcontrib.programoutput'] html_show_sourcelink = False html_show_sphinx = False html_sidebars = {'**': ['globaltoc.html', 'github.html']} diff --git a/docs/docs-requirements.txt b/docs/docs-requirements.txt new file mode 100644 index 00000000..d921fd18 --- /dev/null +++ b/docs/docs-requirements.txt @@ -0,0 +1 @@ +sphinxcontrib-programoutput==0.11 diff --git a/docs/index.rst b/docs/index.rst index 7b9d59db..be98dbbf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -61,15 +61,7 @@ machines in the wild. To accomplish bootstrap, Mitogen uses a single 600 byte SSH command line and 8KB of its own source code sent to stdin of the remote SSH connection. -.. code:: - - $ python preamble_size.py - SSH command size: 624 - Preamble size: 7599 (7.42KiB) - mitogen.master size: 5989 (5.85KiB) - mitogen.ssh size: 953 (0.93KiB) - mitogen.sudo size: 652 (0.64KiB) - mitogen.fakessh size: 2516 (2.46KiB) +.. command-output:: python ../preamble_size.py Once bootstrapped, the remote process is configured with a customizable **argv[0]**, readily visible to system administrators of the remote machine