Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SchlenkR committed Dec 24, 2023
1 parent cb2dc46 commit cdf8fdc
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build-and-publish-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -338,5 +338,5 @@ ASALocalRun/

# fsdocs
tmp/
output/
.docsOutput/
.fsdocs/
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion docu.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit cdf8fdc

Please sign in to comment.