mirror of
https://github.com/mitmproxy/mitmproxy.git
synced 2025-02-17 04:07:49 +00:00
489dd77dbe
Some checks failed
autofix.ci / autofix (push) Has been cancelled
CI / lint (push) Has been cancelled
CI / filename-matching (push) Has been cancelled
CI / mypy (push) Has been cancelled
CI / individual-coverage (push) Has been cancelled
CI / test (macos-latest, 3.13-dev) (push) Has been cancelled
CI / test (ubuntu-latest, 3.10) (push) Has been cancelled
CI / test (ubuntu-latest, 3.11) (push) Has been cancelled
CI / test (ubuntu-latest, 3.12) (push) Has been cancelled
CI / test (ubuntu-latest, 3.13-dev) (push) Has been cancelled
CI / test (windows-latest, 3.13-dev) (push) Has been cancelled
CI / test-old-dependencies (push) Has been cancelled
CI / build (macos-12, macos-x86_64) (push) Has been cancelled
CI / build (macos-14, macos-arm64) (push) Has been cancelled
CI / build (ubuntu-20.04, linux) (push) Has been cancelled
CI / build (windows-2019, windows) (push) Has been cancelled
CI / build-wheel (push) Has been cancelled
CI / build-windows-installer (push) Has been cancelled
CI / test-web-ui (push) Has been cancelled
CI / docs (push) Has been cancelled
CI / test-docker (push) Has been cancelled
CI / check (push) Has been cancelled
CI / deploy-docker (push) Has been cancelled
CI / deploy (push) Has been cancelled
Mitmproxy Documentation
This directory houses the mitmproxy documentation available at https://docs.mitmproxy.org/.
Prerequisites
- Install hugo "extended".
- Windows users: Depending on your git settings, you may need to manually create a symlink from
/docs/src/examplesto/examples.
Editing docs locally
- Make sure the mitmproxy Python package is installed and the virtual python environment was activated. See CONTRIBUTING.md for details.
- Run
./build.pyto generate additional documentation source files. - Now you can change your working directory to
./srcand runhugo server -D.