From cdf8fdc017d41ea676701ceb99c345bdec6a0653 Mon Sep 17 00:00:00 2001 From: SchlenkR Date: Sun, 24 Dec 2023 11:30:51 +0100 Subject: [PATCH] docs --- .github/workflows/build-and-publish-docs.yml | 2 +- .gitignore | 2 +- README.md | 2 +- docs/index.md | 2 +- docu.ps1 | 3 ++- 5 files changed, 6 insertions(+), 5 deletions(-) diff --git a/.github/workflows/build-and-publish-docs.yml b/.github/workflows/build-and-publish-docs.yml index 8a41ba77..67c4bd89 100644 --- a/.github/workflows/build-and-publish-docs.yml +++ b/.github/workflows/build-and-publish-docs.yml @@ -31,7 +31,7 @@ jobs: - name: Upload docs artifact to GH pages uses: actions/upload-pages-artifact@v2 with: - path: ./output + path: ./.docsOutput deploy: runs-on: ubuntu-latest diff --git a/.gitignore b/.gitignore index a3bb39cf..9cfe6da5 100644 --- a/.gitignore +++ b/.gitignore @@ -338,5 +338,5 @@ ASALocalRun/ # fsdocs tmp/ -output/ +.docsOutput/ .fsdocs/ \ No newline at end of file diff --git a/README.md b/README.md index 2bff7127..295cec86 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ For common tasks, there are powershell files located in the repo root: * `./test.ps1`: Runs all tests (sources in `./src/Tests`). * You can pass args to this task. E.g. for executing only some tests: `./test.ps1 --filter Name~'Response Decompression'` -* `./docu.ps1`: Rebuilds the FsHttp documentation site (sources in `./src/docs`; output goes to `./docs`). +* `./docu.ps1`: Rebuilds the FsHttp documentation site (sources in `./src/docs`). * `./docu-watch.ps1`: Run it if you are working on the documentation sources, and want to see the result in a browser. * `./publish.ps1`: Publishes all packages (FsHttp and it's integration packages for Newtonsoft and FSharp.Data) to NuGet. * Always have a look at `./src/Directory.Build.props` and keep the file up-to-date. diff --git a/docs/index.md b/docs/index.md index 3f1350ee..625cf550 100644 --- a/docs/index.md +++ b/docs/index.md @@ -112,7 +112,7 @@ For common tasks, there are powershell files located in the repo root: * `./test.ps1`: Runs all tests (sources in `./src/Tests`). * You can pass args to this task. E.g. for executing only some tests: `./test.ps1 --filter Name~'Response Decompression'` -* `./docu.ps1`: Rebuilds the FsHttp documentation site (sources in `./src/docs`; output goes to `./docs`). +* `./docu.ps1`: Rebuilds the FsHttp documentation site (sources in `./src/docs`). * `./docu-watch.ps1`: Run it if you are working on the documentation sources, and want to see the result in a browser. * `./publish.ps1`: Publishes all packages (FsHttp and it's integration packages for Newtonsoft and FSharp.Data) to NuGet. * Always have a look at `./src/Directory.Build.props` and keep the file up-to-date. diff --git a/docu.ps1 b/docu.ps1 index b7b05974..b01b26e1 100644 --- a/docu.ps1 +++ b/docu.ps1 @@ -35,4 +35,5 @@ dotnet fsdocs ` --properties Configuration=Release TargetFramework=net8.0 ` --sourcerepo https://github.com/fsprojects/FsHttp/blob/master/src ` --parameters root /FsHttp/ ` - --strict + --strict ` + --output ./.docsOutput