Skip to content

Commit c6edb62

Browse files
committed
clarify fallback_to_build_date
1 parent 66919dd commit c6edb62

File tree

1 file changed

+1
-3
lines changed

1 file changed

+1
-3
lines changed

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,7 @@ Specify a two letter [ISO639](https://en.wikipedia.org/wiki/List_of_ISO_639-1_co
8989

9090
### `fallback_to_build_date`
9191

92-
If you need to ignore the Git exceptions during `git log` operations, set this option to `true` (default is `false`).
93-
94-
In addition, if you need to completely ignore if Git is reachable or installed, you should set the environment variable ["GIT_PYTHON_REFRESH"] to `quiet`.
92+
If set to `true` (default is `false`) the plugin will use the time when running `mkdocs build` instead of the git revision date. This means the revision date will be inaccurate, but this can be useful if your build environment has no access to GIT and you want to ignore the Git exceptions during `git log`.
9593

9694
----
9795

0 commit comments

Comments
 (0)