Skip to content

Commit 2a4632c

Browse files
committed
Update README with local server troubleshooting information
1 parent b194925 commit 2a4632c

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This repo contains all documentation for fastlane. You can find the `.md` files inside the [docs](docs) folder.
44

5-
To preview the updated documentation locally, just clone the repo, modify the file, and run
5+
To preview the updated documentation locally, just clone the repo, modify the file, and run. Note that some of the files are in [generated](docs/generated) folder and are later copied with mkdocs prebuild hook.
66

77
```
88
mkdocs serve
@@ -24,10 +24,17 @@ Once a PR is merged into master, the latest version will automatically be deploy
2424
brew install python3 # if you don't have pip already
2525
brew install pipenv
2626
pipenv --three
27-
pipenv shell
27+
# install dependencies from Pipfile.lock and run shell
2828
pipenv install
29+
pipenv shell
2930
```
3031

3132
## Adding a Python dependency
3233

3334
Likely, to add a [Markdown extension](https://pythonhosted.org/Markdown/extensions/), install it with `pipenv install <some extension>` after making sure the virtualenv is loaded (`pipenv shell`).
35+
36+
## Troubleshooting local docs server
37+
38+
Running local server with `mkdocs serve` takes several minutes. It looks like `mkdocs` needs several minutes to read `available-plugins.md`. It can be confirmed by running `mkdocs serve --verbose` as `mkdocs` is stuck at reading this file.
39+
40+
To test changes on other pages than list of available plugins, its convenient to edit `docs/generated/available-plugins.md` and remove all its content and save file before running `mkdocs serve`.

0 commit comments

Comments
 (0)