Grasscutters/mitmproxy
3
0
Fork 0
mirror of https://github.com/Grasscutters/mitmproxy.git synced 2024-12-01 19:48:34 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #3667 from jannst/fix_docs_readme

Browse Source 
hugo server -D fails if html file in docs/src/generated are not present
This commit is contained in:
Maximilian Hils 2019-10-13 18:21:08 +02:00 committed by GitHub
commit 4e0598fb5a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/README.md
View File

@ -7,7 +7,8 @@ This directory houses the mitmproxy documentation available at <https://docs.mit
1. Install [hugo](https://gohugo.io/). 1. Install [hugo](https://gohugo.io/).
2. Windows users: Depending on your git settings, you may need to manually create a symlink from 2. Windows users: Depending on your git settings, you may need to manually create a symlink from
/docs/src/examples to /examples. /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. Now you can run `hugo server -D` in ./src.