Bump fsdocs-tool from 14.0.1 to 18.1.1

[dependabot[bot]]

Bumps fsdocs-tool from 14.0.1 to 18.1.1.

Changelog

Sourced from fsdocs-tool's changelog.

18.1.1

• Pass --multiemit- as default option for FsiEvaluator.

18.1.0

• Collapsible ApiDocs member info #778. The issue was fixed collaboratively in an Amplifying F# session with a recording that can be found here.

18.0.0

• Update FCS to 43.7.200
• Target net6.0 for fsdocs-tool #799

17.4.1

• Update ipynb output metadata #809

17.4.0

• One FSI evaluator per docs file #737

17.3.0

• Better test project detection #800

17.2.3

• Fix external docs link #794

17.2.2

• Improvement for <seealso/> #789

17.2.1

• Fix support for <exclude/> #786

17.2.0

• Resolve markdown links in raw html #769

17.1.0

• Add syntax highlighting to API docs

17.0.0

• Update to .NET 7.0.100

16.1.1

... (truncated)

Upgrade guide

Sourced from fsdocs-tool's upgrade guide.

---

category: Advanced categoryindex: 3 index: 1

Upgrading to fsdocs

Here are the typical steps to upgrade a repo based on ProjectScaffold to use fsdocs

1. Run

   [lang=text]
   dotnet new tool
   dotnet tool install fsdocs-tool
   

2. Delete all of docs\tools particularly docs\tool\generate.fsx. Keep a copy of any templates for reference as you'll have to copy some bits across to the new template.

3. Put your docs directory so it reflects the final shape of the site. For example move the content of docs\input\* and docs\files\* directly to docs\*

4. Follow the notes in styling to start to style your site.

5. Run

   [lang=text]
   dotnet fsdocs watch
   

   and edit and test your docs.

6. If using FAKE adjust build.fsx e.g.

   [lang=text]
   Target.create "GenerateDocs" (fun _ ->
      Shell.cleanDir ".fsdocs"
      DotNet.exec id "fsdocs" "build --clean" |> ignore
   )
   Target.create "ReleaseDocs" (fun _ ->
   Git.Repository.clone "" projectRepo "temp/gh-pages"
   Git.Branches.checkoutBranch "temp/gh-pages" "gh-pages"
   Shell.copyRecursive "output" "temp/gh-pages" true |> printfn "%A"
   Git.CommandHelper.runSimpleGitCommand "temp/gh-pages" "add ." |> printfn "%s"
   let cmd = sprintf """commit -a -m "Update generated documentation for version %s""" release.NugetVersion
   Git.CommandHelper.runSimpleGitCommand "temp/gh-pages" cmd |> printfn "%s"
   Git.Branches.push "temp/gh-pages"
   )
   

7. Consider creating docs\_template.fsx and docs\_template.ipynb to enable co-generation of F# scripts and F# notebooks.

   If you add support for notebooks and scripts, consider adding mybinder links to each of your literate executable content pages. For example like this.

... (truncated)

Commits

• See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

---

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

[dependabot[bot]]

Superseded by #94.