diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0e5f8a7..a06436e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -70,7 +70,7 @@ Click on the pencil icon at the top right of any docs page to make small changes 1. Change the working directory to `./ChunkyDocs`. -2. Serve the site for development by using either the command, `CHUNKY_VERSION=20405 python -m mkdocs serve`, or the command, `CHUNKY_VERSION=20500 python -m mkdocs serve`, depending on the version of Chunky for which you want to serve documentation. +2. Serve the site for development by using either the command, `CHUNKY_VERSION=20406 python -m mkdocs serve`, or the command, `CHUNKY_VERSION=20500 python -m mkdocs serve`, depending on the version of Chunky for which you want to serve documentation. Alternatively, on Windows, you can run either "serve_stable.bat" or "serve_snapshot.bat", depending on the version of Chunky for which you want to build documentation. diff --git a/README.md b/README.md index b0fee4a..d79d95a 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,9 @@ This site uses mkdocs. Pyt - Step 4: If running Windows, simply run "serve_stable.bat" or "serve_snapshot.bat", depending on the version of Chunky for which you want to serve documentation. Otherwise, change the working directory to "./ChunkyDocs". -- Step 5: Serve the site for development by using the either the command, `CHUNKY_VERSION=20405 python -m mkdocs serve`, or the command, `CHUNKY_VERSION=20500 python -m mkdocs serve`, depending on the version of Chunky for which you want to serve documentation. +- Step 5: Serve the site for development by using the either the command, `CHUNKY_VERSION=20406 python -m mkdocs serve`, or the command, `CHUNKY_VERSION=20500 python -m mkdocs serve`, depending on the version of Chunky for which you want to serve documentation. -- Step 6: Build a preview of the final site by using either the command, `CHUNKY_VERSION=20405 python -m mkdocs build`, or the command `CHUNKY_VERSION=20500 python -m mkdocs build`, depending on the version of Chunky for which you want to build documentation. On Windows, first run either the command, `set CHUNKY_VERSION=20405`, or the command, `set CHUNKY_VERSION=20500`, depending on the version of Chunky for which you want to build documentation. Then run the command, `python -m mkdocs serve`. +- Step 6: Build a preview of the final site by using either the command, `CHUNKY_VERSION=20406 python -m mkdocs build`, or the command `CHUNKY_VERSION=20500 python -m mkdocs build`, depending on the version of Chunky for which you want to build documentation. On Windows, first run either the command, `set CHUNKY_VERSION=20406`, or the command, `set CHUNKY_VERSION=20500`, depending on the version of Chunky for which you want to build documentation. Then run the command, `python -m mkdocs serve`. ### With Docker diff --git a/build.sh b/build.sh index 8391c35..782bbae 100755 --- a/build.sh +++ b/build.sh @@ -14,7 +14,7 @@ else sed -i 's/..\/versions.json/\/docs\/versions.json/g' ../docs/snapshot/assets/javascripts/bundle*.min.js fi -CHUNKY_VERSION=20405 python -m mkdocs build +CHUNKY_VERSION=20406 python -m mkdocs build cp -r site/* ../docs/ # get the versions from /docs/versions.json instead of the hard-coded ../versions.json if [[ "$OSTYPE" == "darwin"* ]]; then diff --git a/serve_stable.bat b/serve_stable.bat index 7bd26f7..13f3ad8 100644 --- a/serve_stable.bat +++ b/serve_stable.bat @@ -1,6 +1,6 @@ CD /d %~dp0/ChunkyDocs -set CHUNKY_VERSION=20405 +set CHUNKY_VERSION=20406 python -m mkdocs serve