Skip to content

Commit

Permalink
docfx: version 2.59.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
swharden committed Dec 23, 2022
1 parent 02b4020 commit 4fc19c4
Show file tree
Hide file tree
Showing 14 changed files with 3,369 additions and 513 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -307,3 +307,5 @@ tests/data/sample.csproj
src/ScottPlot/ScottPlot.xml
src/ScottPlot4/ScottPlot/ScottPlot.xml
src/ScottPlot4/ScottPlot/ScottPlot.xml
dev/docfx/_exported_templates/
dev/docfx/api/*.yml
12 changes: 8 additions & 4 deletions dev/docfx/.gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
obj
api/*.yml
api/.manifest
###############
# folder #
###############
/**/DROP/
/**/TEMP/
/**/packages/
/**/bin/
/**/obj/
_site
_api/
3,254 changes: 3,254 additions & 0 deletions dev/docfx/api/.manifest

Large diffs are not rendered by default.

27 changes: 0 additions & 27 deletions dev/docfx/api/index.md
Original file line number Diff line number Diff line change
@@ -1,27 +0,0 @@
# ScottPlot 4.1.16 API

This documentation is specific to ScottPlot version `4.1.16`.

Information about other versions and additional documentation can be found at **http://swharden.com/scottplot**

See the [**ScottPlot Cookbook**](https://swharden.com/scottplot/cookbook) and [**ScottPlot FAQ**](https://swharden.com/scottplot/faq) for additional documentation.

### The Plot Module

* Plots are managed by interacting with the [**`ScottPlot.Plot`**](xref:ScottPlot.Plot) class

### Plottables

* Plot types are defined in the [**`ScottPlot.Plottable`**](xref:ScottPlot.Plottable) namespace

### User Controls

* [**`ScottPlot.FormsPlot`**](xref:ScottPlot.FormsPlot) - Windows Forms
* [**`ScottPlot.WpfPlot`**](xref:ScottPlot.WpfPlot) - Windows Presentation Format
* [**`ScottPlot.AvaPlot`**](xref:ScottPlot.Avalonia.AvaPlot) - Avalonia

User controls have common public fields/methods:
* [`Plot`](xref:ScottPlot.Plot) - interact with this to manage data
* [`Configuration`](xref:ScottPlot.Control.Configuration) - interact with this to manage interactive behavior
* `Render()` - redraw the plot on the screen
* `RenderRequest()` - non-blocking request to redraw the plot
131 changes: 62 additions & 69 deletions dev/docfx/docfx.json
Original file line number Diff line number Diff line change
@@ -1,75 +1,68 @@
{
"metadata": [
"metadata": [
{
"src": [
{
"src": [
{
"files": [
"ScottPlot/ScottPlot.csproj",
"ScottPlot.WinForms/ScottPlot.WinForms.csproj",
"ScottPlot.WPF/ScottPlot.WPF.csproj",
"ScottPlot.Avalonia/ScottPlot.Avalonia.csproj",
"ScottPlot.Eto/ScottPlot.Eto.csproj"
],
"exclude": [
"**/bin/**",
"**/obj/**"
],
"src": "../../src/ScottPlot4"
}
],
"dest": "_api",
"disableGitFeatures": true,
"disableDefaultFilter": false,
"_disableAffix": true
"src": "../../src/ScottPlot4",
"files": [
"ScottPlot/*.csproj",
"ScottPlot.WinForms/*.csproj",
"ScottPlot.WPF/*.csproj",
"ScottPlot.Avalonia/*.csproj",
"ScottPlot.Eto/*.csproj",
]
}
],
"dest": "api",
"disableGitFeatures": false,
"disableDefaultFilter": false
}
],
"build": {
"content": [
{
"files": [
"api/**.yml",
"api/index.md"
]
},
{
"files": [
"toc.yml",
"*.md"
]
}
],
"build": {
"content": [
{
"files": [
"_api/**.yml",
"api/index.md",
"toc.yml",
"index.md"
]
}
],
"resource": [
{
"files": [
"icon.png"
]
}
],
"overwrite": [
{
"files": [
"apidoc/**.md"
],
"exclude": [
"obj/**",
"_site/**"
]
}
],
"dest": "_site",
"globalMetadata": {
"_appTitle": "ScottPlot 4.1.16 API",
"repo": "https://github.com/ScottPlot/ScottPlot",
"branch": "master",
"apiSpecFolder": "dev/docfx",
"_appLogoPath": "icon.png",
"_appFaviconPath": "icon.png"
},
"template": [
"default",
"template-material"
"resource": [
{
"files": [
"images/**"
]
}
],
"overwrite": [
{
"files": [
"apidoc/**.md"
],
"postProcessors": [],
"markdownEngineName": "markdig",
"noLangKeyword": false,
"keepFileLink": false,
"cleanupCacheHistory": false,
"disableGitFeatures": true
}
"exclude": [
"obj/**",
"_site/**"
]
}
],
"dest": "_site",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"template": [
"default",
"templates/sp4"
],
"postProcessors": [],
"markdownEngineName": "markdig",
"noLangKeyword": false,
"keepFileLink": false,
"cleanupCacheHistory": false,
"disableGitFeatures": false
}
}
Binary file removed dev/docfx/icon.png
Binary file not shown.
36 changes: 9 additions & 27 deletions dev/docfx/index.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,9 @@
# ScottPlot 4.1.16 API

This documentation is specific to ScottPlot version `4.1.16`.

Information about other versions and additional documentation can be found at **http://swharden.com/scottplot**

See the [**ScottPlot Cookbook**](https://swharden.com/scottplot/cookbook) and [**ScottPlot FAQ**](https://swharden.com/scottplot/faq) for additional documentation.

### The Plot Module

* Plots are managed by interacting with the [**`ScottPlot.Plot`**](xref:ScottPlot.Plot) class

### Plottables

* Plot types are defined in the [**`ScottPlot.Plottable`**](xref:ScottPlot.Plottable) namespace

### User Controls

* [**`ScottPlot.FormsPlot`**](xref:ScottPlot.FormsPlot) - Windows Forms
* [**`ScottPlot.WpfPlot`**](xref:ScottPlot.WpfPlot) - Windows Presentation Format
* [**`ScottPlot.AvaPlot`**](xref:ScottPlot.Avalonia.AvaPlot) - Avalonia

User controls have common public fields/methods:
* [`Plot`](xref:ScottPlot.Plot) - interact with this to manage data
* [`Configuration`](xref:ScottPlot.Control.Configuration) - interact with this to manage interactive behavior
* `Render()` - redraw the plot on the screen
* `RenderRequest()` - non-blocking request to redraw the plot
ScottPlot API Documentation:
* [ScottPlot 4.1](api)
* ScottPlot 5.0 (still in development)

Additional Links:
* [ScottPlot.NET Home Page](https://scottplot.net/)
* [ScottPlot 4 Cookbook](https://scottplot.net/cookbook/4.1/)
* [ScottPlot FAQ](https://scottplot.net/faq/)
* [ScottPlot on GitHub](https://github.com/scottplot/scottplot)
26 changes: 0 additions & 26 deletions dev/docfx/template-material/partials/head.tmpl.partial

This file was deleted.

Loading

0 comments on commit 4fc19c4

Please sign in to comment.