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/render_examples.py | |
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/render_examples.py')
-rwxr-xr-x | docs/render_examples.py | 10 |
1 files changed, 6 insertions, 4 deletions
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))) |