Merge pull request #101 from quintusm/documentation-update-2024-05

Update the documentation generation using fsdocs.  This request does not yet update the live documentation

Author: quintusm

Directory.Build.props

@@ -0,0 +1,9 @@
+<Project>
+<PropertyGroup>
+    <RepositoryUrl>https://github.com/fsprojects/ExcelProvider</RepositoryUrl>
+    <FsDocsLicenseLink>https://github.com/fsprojects/ExcelProvider/blob/master/LICENSE.txt</FsDocsLicenseLink>
+    <FsDocsReleaseNotesLink>https://github.com/fsprojects/ExcelProvider/blob/master/RELEASE_NOTES.md</FsDocsReleaseNotesLink>
+    <PackageProjectUrl>https://fsprojects.github.io/ExcelProvider/</PackageProjectUrl>
+    <FsDocsLogoSource>images/logo.png</FsDocsLogoSource>
+</PropertyGroup>
+</Project>

docs/content/DataTypes.xlsx renamed to docs/DataTypes.xlsx

@@ -1,5 +1,15 @@
+(**
+---
+title: Accessing Cells
+category: Documentation
+categoryindex: 2
+index: 4
+---
+*)
+
+
 (*** hide ***)
-#I "../../bin/ExcelProvider"
+#r "../bin/ExcelProvider.Runtime/netstandard2.0/ExcelProvider.Runtime.dll"
 
 (**
 Accessing Cells
@@ -11,7 +21,7 @@ To access a particular cell you need to access the relevant row and use the fiel
 Example
 -------
 
-![alt text](img/MultSheets.png "Excel sample file with multiple sheets")
+![alt text](images/MultSheets.png "Excel sample file with multiple sheets")
 
 This example demonstrates referencing the first column (with name `Fourth`) on row 4:
 
@@ -36,4 +46,4 @@ let testByHeader = rows.[2].GetValue "Fourth"
 (*** include-value: testByIndex ***)
 (*** include-value: testByHeader ***)
 
-(** Accessing cell values by index or string header sacrifices type safety; the result signature is `obj`. *)
+(** Accessing cell values by index or string header sacrifices type safety; the result signature is `obj`. *)

docs/content/DataTypesNoHeader.xlsx renamed to docs/DataTypesNoHeader.xlsx

@@ -1,5 +1,16 @@
+(**
+---
+title: Getting Started
+category: Documentation
+categoryindex: 2
+index: 1
+---
+*)
+
+
+
 (*** hide ***)
-#I "../../bin/ExcelProvider"
+#r "../bin/ExcelProvider.Runtime/netstandard2.0/ExcelProvider.Runtime.dll"
 
 (**
 Getting Started
@@ -11,8 +22,8 @@ If you are using F# scripts then just add the dll using the `#r` option.
 
 If you then open `FSharp.Interop.Excel` you will have access to the Type Provider functionality.
 
-You can then create a type for an individual workbook. The simplest option is to specify just the name of the workbook. 
-You will then be given typed access to the data held in the first sheet. 
+You can then create a type for an individual workbook. The simplest option is to specify just the name of the workbook.
+You will then be given typed access to the data held in the first sheet.
 The first row of the sheet will be treated as field names and the subsequent rows will be treated as values for these fields.
 
 Parameters
@@ -26,10 +37,11 @@ When creating the type you can specify the following parameters:
 * `HasHeaders` Whether the range contains the names of the columns as its first line.
 * `ForceString` Specifies forcing data to be processed as strings. Defaults to `false`.
 
-All but the first are optional. 
+All but the first are optional.
 
 The parameters can be specified by position or by using the name - for example the following are equivalent:
 *)
+open FSharp.Interop.Excel
 
 type MultipleSheets1 = ExcelFile<"MultipleSheets.xlsx", "B">
 type MultipleSheets2 = ExcelFile<"MultipleSheets.xlsx", SheetName="B">
@@ -41,12 +53,11 @@ Example
 
 This example shows the use of the type provider in an F# script on a sheet containing three rows of data:
 
-![alt text](img/DataTypes.png "Excel sample file with different types")
+![alt text](images/DataTypes.png "Excel sample file with different types")
 
 *)
 
 // reference the type provider dll
-#r "ExcelProvider.dll"
 open FSharp.Interop.Excel
 
 // Let the type provider do it's work
@@ -55,4 +66,4 @@ let file = new DataTypesTest()
 let row = file.Data |> Seq.head
 let test = row.Float
 (** And the variable `test` has the following value: *)
-(*** include-value: test ***)
+(*** include-value: test ***)

docs/content/MultipleRegions.xlsx renamed to docs/MultipleRegions.xlsx

@@ -1,5 +1,16 @@
+(**
+---
+title: Without Headers
+category: Documentation
+categoryindex: 2
+index: 6
+---
+*)
+
+
+
 (*** hide ***)
-#I "../../bin/ExcelProvider"
+#r "../bin/ExcelProvider.Runtime/netstandard2.0/ExcelProvider.Runtime.dll"
 
 (**
 Without Headers
@@ -17,12 +28,12 @@ Example
 
 This example shows the use of the type provider in an F# script on a sheet containing no headers:
 
-![alt text](img/DataTypesNoHeader.png "Excel sample file with different types and no headers")
+![alt text](images/DataTypesNoHeader.png "Excel sample file with different types and no headers")
 
 *)
 
 // reference the type provider dll
-#r "ExcelProvider.dll"
+#r "ExcelProvider.Runtime.dll"
 open FSharp.Interop.Excel
 
 // Let the type provider do it's work
@@ -31,4 +42,4 @@ let file = new DataTypesTest()
 let row = file.Data |> Seq.head
 let test = row.Column2
 (** And the variable `test` has the following value: *)
-(*** include-value: test ***)
+(*** include-value: test ***)

docs/content/MultipleSheets.xlsx renamed to docs/MultipleSheets.xlsx

@@ -1,5 +1,5 @@
 (*** hide ***)
-#I "../../bin"
+#r "../bin/ExcelProvider.Runtime/netstandard2.0/ExcelProvider.Runtime.dll"
 
 (**
 ExcelProvider
@@ -23,15 +23,13 @@ Example
 
 This example demonstrates the use of the type provider:
 
-![alt text](img/DataTypes.png "Excel sample file with different types")
+![alt text](images/DataTypes.png "Excel sample file with different types")
 
 *)
-
 // reference the type provider dll
-#r "ExcelProvider.dll"
+#r "ExcelProvider.Runtime.dll"
 open FSharp.Interop.Excel
 
-
 // Let the type provider do it's work
 type DataTypesTest = ExcelFile<"DataTypes.xlsx">
 let file = new DataTypesTest()
@@ -41,7 +39,7 @@ let row = file.Data |> Seq.head
 
 Now we have strongly typed access to the Excel rows:
 
-![alt text](img/TypedExcel.png "Typed Excel sample file")
+![alt text](images/TypedExcel.png "Typed Excel sample file")
 
 *)
 
@@ -58,27 +56,27 @@ row.Boolean
 Documentation
 -----------------------
 
-For more information see the Documentation pages: 
+For more information see the Documentation pages:
 
  * [Getting Started](getting-started.html) contains an overview of the library.
  * [Accessing Sheets](sheets.html) shows how to access different sheets in a workbook.
  * [Accessing Rows](rows.html) shows how to access individual rows in a worksheet.
  * [Accessing Cells](cells.html) shows how to access individual cells within a row of a worksheet.
  * [Accessing Ranges](ranges.html) shows how to access multiple ranges of data within a worksheet.
  * [Without Headers](headers.html) shows how to process sheets which do not include headers.
- 
+
 
 Contributing and copyright
 --------------------------
 
-The project is hosted on [GitHub][gh] where you can [report issues][issues], fork 
-the project and submit pull requests. If you're adding new public API, please also 
+The project is hosted on [GitHub][gh] where you can [report issues][issues], fork
+the project and submit pull requests. If you're adding new public API, please also
 consider adding [samples][content] that can be turned into a documentation. You might
 also want to read [library design notes][readme] to understand how it works.
 
-The library is available under Public Domain license, which allows modification and 
-redistribution for both commercial and non-commercial purposes. For more information see the 
-[License file][license] in the GitHub repository. 
+The library is available under Public Domain license, which allows modification and
+redistribution for both commercial and non-commercial purposes. For more information see the
+[License file][license] in the GitHub repository.
 
   [content]: https://github.com/fsprojects/ExcelProvider/tree/master/docs/content
   [gh]: https://github.com/fsprojects/ExcelProvider

docs/content/cells.fsx renamed to docs/cells.fsx

@@ -1,5 +1,15 @@
+(**
+---
+title: Accessing Ranges
+category: Documentation
+categoryindex: 2
+index: 5
+---
+*)
+
+
 (*** hide ***)
-#I "../../bin/ExcelProvider"
+#r "../bin/ExcelProvider.Runtime/netstandard2.0/ExcelProvider.Runtime.dll"
 
 (**
 Accessing Ranges
@@ -13,7 +23,7 @@ You can either specify this as the second parameter or the named `Range` paramet
 Example
 -------
 
-![alt text](img/Excel.png "Excel sample file with multiple ranges")
+![alt text](images/Excel.png "Excel sample file with multiple ranges")
 
 This example demonstrates referencing multiple ranges:
 
@@ -32,4 +42,4 @@ let test1 = rows.[0].First
 let test2 = rows.[0].Fourth
 (** And the variables `test1` and `test2` have the following values: *)
 (*** include-value: test1 ***)
-(*** include-value: test2 ***)
+(*** include-value: test2 ***)

docs/content/getting-started.fsx renamed to docs/getting-started.fsx

@@ -1,5 +1,15 @@
+(**
+---
+title: Accessing Rows
+category: Documentation
+categoryindex: 2
+index: 3
+---
+*)
+
+
 (*** hide ***)
-#I "../../bin/ExcelProvider"
+#r "../bin/ExcelProvider.Runtime/netstandard2.0/ExcelProvider.Runtime.dll"
 
 (**
 Accessing Rows
@@ -10,14 +20,14 @@ Rows are returned as a sequence from the `Data` element of the ExcelFile type.
 Example
 -------
 
-![alt text](img/MultSheets.png "Excel sample file with multiple sheets")
+![alt text](images/MultSheets.png "Excel sample file with multiple sheets")
 
 This example demonstrates loading the second row (with index 1) into the variable test:
 
 *)
 
 // reference the type provider dll
-#r "ExcelProvider.dll"
+#r "ExcelProvider.Runtime.dll"
 open FSharp.Interop.Excel
 
 // Let the type provider do it's work
@@ -26,4 +36,4 @@ let file = new MultipleSheetsSecond()
 let rows = file.Data |> Seq.toArray
 let test = rows.[1]
 (** And the variable `test` has the following value: *)
-(*** include-value: test ***)
+(*** include-value: test ***)

docs/content/headers.fsx renamed to docs/headers.fsx

@@ -1,5 +1,16 @@
+(**
+---
+title: Accessing Sheets
+category: Documentation
+categoryindex: 2
+index: 2
+---
+*)
+
+
 (*** hide ***)
-#I "../../bin/ExcelProvider"
+#r "../bin/ExcelProvider.Runtime/netstandard2.0/ExcelProvider.Runtime.dll"
+
 
 (**
 Accessing Sheets
@@ -12,14 +23,14 @@ If you do not include a second parameter then the first sheet in the workbook is
 Example
 -------
 
-![alt text](img/MultSheets.png "Excel sample file with multiple sheets")
+![alt text](images/MultSheets.png "Excel sample file with multiple sheets")
 
 This example demonstrates referencing the second sheet (with name `B`):
 
 *)
 
 // reference the type provider dll
-#r "ExcelProvider.dll"
+#r "ExcelProvider.Runtime.dll"
 open FSharp.Interop.Excel
 
 // Let the type provider do it's work
@@ -28,4 +39,4 @@ let file = new MultipleSheetsSecond()
 let rows = file.Data |> Seq.toArray
 let test = rows.[0].Fourth
 (** And the variable `test` has the following value: *)
-(*** include-value: test ***)
+(*** include-value: test ***)