mitmproxy/docs
Alex Hedges af8d5b9ce6
Fix Hugo deprecation error (#7372)
* Update Hugo installed in CI from `v0.92.1` to `v0.139.3`

The version in CI is close to 3 years old, which means it does not
encounter the same problems that newer installations of Hugo do.

* Fix Hugo deprecation error

I got the following error when building the documentation with Hugo
`v0.139.3`:

```
ERROR deprecated: data.GetJSON was deprecated in Hugo v0.123.0 and will be removed in Hugo 0.140.0. use resources.Get or resources.GetRemote with transform.Unmarshal.
```

I fixed the error by implementing the change the error recommended.
2024-12-04 09:41:45 +01:00
..
bucketassets
raw
scripts Add HttpConnectedHook and HttpConnectErrorHook (#6930) 2024-06-15 00:02:54 +05:30
src Fix Hugo deprecation error (#7372) 2024-12-04 09:41:45 +01:00
.gitignore
build.py
modd.conf
README.md
setup.sh
upload-archive.sh
upload-stable.sh

Mitmproxy Documentation

This directory houses the mitmproxy documentation available at https://docs.mitmproxy.org/.

Prerequisites

  1. Install hugo "extended".
  2. Windows users: Depending on your git settings, you may need to manually create a symlink from /docs/src/examples to /examples.

Editing docs locally

  1. Make sure the mitmproxy Python package is installed and the virtual python environment was activated. See CONTRIBUTING.md for details.
  2. Run ./build.py to generate additional documentation source files.
  3. Now you can change your working directory to ./src and run hugo server -D.