vee1e/mitmproxy
1
0
Fork 0
mirror of https://github.com/vee1e/mitmproxy.git synced 2026-09-01 18:27:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
mitmproxy/docs
History
Matteo Luppi 590eef0d44
fix docs (#6696) 
#### Description

close #6682 

#### Checklist

 - [ ] I have updated tests where applicable.
 - [ ] I have added an entry to the CHANGELOG.
2024-02-28 23:04:45 +01:00
..
bucketassets
raw
scripts Migrate to ruff (#6433) 2023-10-31 16:03:53 +01:00
src fix docs (#6696) 2024-02-28 23:04:45 +01:00
.gitignore
build.py Migrate to ruff (#6433) 2023-10-31 16:03:53 +01:00
modd.conf
README.md
setup.sh
upload-archive.sh
upload-stable.sh

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