vee1e/mitmproxy
1
0
Fork 0
mirror of https://github.com/vee1e/mitmproxy.git synced 2026-09-04 11:47:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
mitmproxy/docs
History
larpineer 99fed544e6
Docs: Change 'uvx' to 'uv tool install' for Installation from PyPI (#7990) 
Change 'uvx' to 'uv tool install'

'uvx' is an alias for 'uv tool run' that installs packages in a temporary virtual environment that is deleted when the uv cache is cleaned. The correct installation command should be 'uv tool install' which installs the virtual environment in the uv tools directory and makes the executable available on the PATH.
See: https://docs.astral.sh/uv/concepts/tools/
2026-01-02 01:40:38 +01:00
..
bucketassets master branch -> main branch 2021-03-30 15:30:45 +02:00
raw
scripts introduce new contentview API (#7623) 2025-04-21 14:56:58 +02:00
src Docs: Change 'uvx' to 'uv tool install' for Installation from PyPI (#7990) 2026-01-02 01:40:38 +01:00
.gitignore
build.py Migrate to ruff (#6433) 2023-10-31 16:03:53 +01:00
modd.conf docs: first prototype to link from events to API reference 2021-02-05 09:15:54 +01:00
README.md Update README.md (#7594) 2025-03-09 11:02:09 +01:00
setup.sh
upload-archive.sh Improve Shell Script syntax (#4497) 2021-03-11 19:12:03 +01:00
upload-stable.sh clean doc folder before building, fixes #4405 (#4406) 2021-01-22 01:40:08 +01:00

README.md

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 ./docs/build.py to generate additional documentation source files.
  3. Now you can change your working directory to ./docs/src and run hugo server -D.