diff options
author | Thomas Kriechbaumer <thomas@kriechbaumer.name> | 2020-04-11 12:25:56 +0200 |
---|---|---|
committer | Thomas Kriechbaumer <thomas@kriechbaumer.name> | 2020-04-11 12:25:56 +0200 |
commit | 55527c00eb35bf3b07b361363fd8ca2961afc8ba (patch) | |
tree | 4d9067ff2bcfd921dcb24852b522537f948e6801 /docs | |
parent | 5ea75a1a8176f764429fb45875626b1b7ef6644c (diff) | |
download | mitmproxy-55527c00eb35bf3b07b361363fd8ca2961afc8ba.tar.gz mitmproxy-55527c00eb35bf3b07b361363fd8ca2961afc8ba.tar.bz2 mitmproxy-55527c00eb35bf3b07b361363fd8ca2961afc8ba.zip |
docs: rename docs scripts and improve template
Diffstat (limited to 'docs')
-rw-r--r-- | docs/README.md | 2 | ||||
-rwxr-xr-x | docs/build-archive | 4 | ||||
-rwxr-xr-x | docs/build-current | 14 | ||||
-rwxr-xr-x | docs/build.sh | 23 | ||||
-rwxr-xr-x | docs/ci.sh (renamed from docs/ci) | 12 | ||||
-rwxr-xr-x | docs/render_examples.py | 10 | ||||
-rwxr-xr-x | docs/setup.sh (renamed from docs/setup) | 10 | ||||
-rwxr-xr-x | docs/upload-archive.sh (renamed from docs/upload-archive) | 8 | ||||
-rwxr-xr-x | docs/upload-stable.sh (renamed from docs/upload-stable) | 8 |
9 files changed, 58 insertions, 33 deletions
diff --git a/docs/README.md b/docs/README.md index 5c99fb39..24c24d24 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,7 +8,7 @@ This directory houses the mitmproxy documentation available at <https://docs.mit 2. Windows users: Depending on your git settings, you may need to manually create a symlink from /docs/src/examples to /examples. 3. Make sure the mitmproxy Python package is installed. - 4. Run `./build-current` to generate the documentation source files in `./src/generated`. + 4. Run `./build.sh` to generate additional documentation source files. Now you can run `hugo server -D` in ./src. diff --git a/docs/build-archive b/docs/build-archive deleted file mode 100755 index 004e625a..00000000 --- a/docs/build-archive +++ /dev/null @@ -1,4 +0,0 @@ -#!/bin/sh -set -e - -DOCS_ARCHIVE=true ./build-current diff --git a/docs/build-current b/docs/build-current deleted file mode 100755 index d01b4e7e..00000000 --- a/docs/build-current +++ /dev/null @@ -1,14 +0,0 @@ -#!/usr/bin/env bash - -set -e - -for script in scripts/* ; do - echo "Generating output for $script ..." - output="${script##*/}" - "$script" > "src/generated/${output%.*}.html" -done - -python3 render_examples > src/content/addons-examples.md - -cd src -hugo diff --git a/docs/build.sh b/docs/build.sh new file mode 100755 index 00000000..aaa52a2f --- /dev/null +++ b/docs/build.sh @@ -0,0 +1,23 @@ +#!/usr/bin/env bash + +set -o errexit +set -o pipefail +set -o nounset +# set -o xtrace + +SCRIPTPATH="$( cd "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )" +pushd ${SCRIPTPATH} + +for script in scripts/* ; do + output="${script##*/}" + output="src/generated/${output%.*}.html" + echo "Generating output for ${script} into ${output} ..." + "${script}" > "${output}" +done + +output="src/content/addons-examples.md" +echo "Generating examples content page into ${output} ..." +./render_examples.py > "${output}" + +cd src +hugo @@ -1,9 +1,13 @@ -#!/bin/bash -set -e +#!/usr/bin/env bash -# This script gets run from CI to render and upload docs +set -o errexit +set -o pipefail +set -o nounset +# set -o xtrace -./build-current +# This script gets run from CI to render and upload docs for the master branch. + +./build.sh # Only upload if we have defined credentials - we only have these defined for # trusted commits (i.e. not PRs). diff --git a/docs/render_examples.py b/docs/render_examples.py index b6fa42eb..9c6dea74 100755 --- a/docs/render_examples.py +++ b/docs/render_examples.py @@ -14,10 +14,12 @@ menu: # Examples of Addons and Scripts +The most recent set of examples is also available [on our GitHub project](https://github.com/mitmproxy/mitmproxy/tree/master/examples). + """) base = os.path.dirname(os.path.realpath(__file__)) -examples_path = os.path.join(base, '../src/examples/') +examples_path = os.path.join(base, 'src/examples/') pathlist = Path(examples_path).glob('**/*.py') examples = [os.path.relpath(str(p), examples_path) for p in sorted(pathlist)] @@ -33,7 +35,7 @@ for ex in examples: print(" * [Examples: {}]({{{{< relref \"addons-examples#{}\">}}}})".format(current_dir, sanitized)) sanitized = ex.replace('/', '').replace('.', '') - print(" * [{}]({{{{< relref \"addons-examples#{}\">}}}})".format(ex, sanitized)) + print(" * [{}]({{{{< relref \"addons-examples#example-{}\">}}}})".format(os.path.basename(ex), sanitized)) current_dir = None current_level = 2 @@ -43,6 +45,6 @@ for ex in examples: print("#" * current_level, current_dir) print(textwrap.dedent(""" - {} {} + {} Example: {} {{{{< example src="{}" lang="py" >}}}} - """.format("#" * (current_level + 1), ex, "/examples/" + ex))) + """.format("#" * (current_level + 1), ex, "examples/" + ex))) diff --git a/docs/setup b/docs/setup.sh index cb63841a..da30a3c9 100755 --- a/docs/setup +++ b/docs/setup.sh @@ -1,5 +1,11 @@ -#!/bin/sh -set -e +#!/usr/bin/env bash + +set -o errexit +set -o pipefail +set -o nounset +# set -o xtrace + +# This is only needed once to provision a new fresh empty S3 bucket. aws configure set preview.cloudfront true aws --profile mitmproxy \ diff --git a/docs/upload-archive b/docs/upload-archive.sh index 3aaeb9be..e35345e9 100755 --- a/docs/upload-archive +++ b/docs/upload-archive.sh @@ -1,5 +1,9 @@ -#!/bin/bash -set -e +#!/usr/bin/env bash + +set -o errexit +set -o pipefail +set -o nounset +# set -o xtrace if [[ $# -eq 0 ]] ; then echo "Please supply a version, e.g. 'v3'" diff --git a/docs/upload-stable b/docs/upload-stable.sh index 5aea7479..a2f20f01 100755 --- a/docs/upload-stable +++ b/docs/upload-stable.sh @@ -1,5 +1,9 @@ -#!/bin/bash -set -e +#!/usr/bin/env bash + +set -o errexit +set -o pipefail +set -o nounset +# set -o xtrace aws configure set preview.cloudfront true aws --profile mitmproxy \ |