diff options
| author | Maximilian Hils <git@maximilianhils.com> | 2019-10-13 18:21:08 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-10-13 18:21:08 +0200 |
| commit | 4e0598fb5a041f76a9a0973ffdf9cb4fcdb033f3 (patch) | |
| tree | 37b31615727002a70eea551520a308de0cc1593c | |
| parent | 902ef59d01f45613ce33520159e157697bcc6f9f (diff) | |
| parent | 68a7d37d5351f62e6b86a01d38f14b00cda1ce84 (diff) | |
| download | mitmproxy-4e0598fb5a041f76a9a0973ffdf9cb4fcdb033f3.tar.gz mitmproxy-4e0598fb5a041f76a9a0973ffdf9cb4fcdb033f3.tar.bz2 mitmproxy-4e0598fb5a041f76a9a0973ffdf9cb4fcdb033f3.zip | |
Merge pull request #3667 from jannst/fix_docs_readme
hugo server -D fails if html file in docs/src/generated are not present
| -rw-r--r-- | docs/README.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/README.md b/docs/README.md index cc06f081..a9ee1113 100644 --- a/docs/README.md +++ b/docs/README.md @@ -7,7 +7,8 @@ This directory houses the mitmproxy documentation available at <https://docs.mit 1. Install [hugo](https://gohugo.io/). 2. Windows users: Depending on your git settings, you may need to manually create a symlink from /docs/src/examples to /examples. - + 3. Make sure the mitmproxy Python package is installed. + 4. Run `./build-current` to generate the documentation source files in `./src/generated`. Now you can run `hugo server -D` in ./src. |