Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove mkdocs #169

Open
wants to merge 21 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,32 @@
# UncertainData changelog

## v.0.14
## v0.15.0

### Breaking changes

- `CertainValue` is renamed to `CertainScalar`.
- Some abstract types are no longer exported.

### Features

- More flexible inputs to `UncertainValue` constructor.

### Documentation

- Shortened and improved documentation.
- Use regular Documenter.jl style, not mkdocs.

## v0.14.1

### Features

- Implement sequential resampling with chunks.

### Misc

- Make some methods more generic (non-breaking).

## v0.14.0

### Breaking changes

Expand Down
9 changes: 6 additions & 3 deletions Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,35 @@ name = "UncertainData"
uuid = "dcd9ba68-c27b-5cea-ae21-829cd07325bf"
authors = ["Kristian Agasøster Haaga <[email protected]>"]
repo = "https://github.com/kahaaga/UncertainData.jl.git"
version = "0.14.0"

version = "0.15.0"

[deps]
Bootstrap = "e28b5b4c-05e8-5b66-bc03-6f0c0a0a06e0"
Combinatorics = "861a8166-3701-5b0c-9a16-15d98fcdc6aa"
Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
DynamicalSystemsBase = "6e36e845-645a-534a-86f2-f5d4aa5a06b4"
HypothesisTests = "09f84164-cd44-5f33-b23f-e6b0d136a0d5"
Interpolations = "a98d9a8b-a2ab-59e6-89dd-64a1c18fca59"
IntervalArithmetic = "d1acc4aa-44c8-5952-acd4-ba5d80a2a253"
KernelDensity = "5ab0869b-81aa-558d-bb23-cbf5423bbe9b"
Measurements = "eff96d63-e80a-5855-80a2-b1b0885c5ab7"
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
RecipesBase = "3cdcf5f2-1ef4-517c-9805-6587b60abb01"
Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
StatsPlots = "f3b207a7-027a-5e70-b257-86293d7955fd"
Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"

[compat]
Bootstrap = "^2.2"
Combinatorics = "^0.7.0, ^1"
Distributions = "0.21, 1, 0.23, 0.24"
DynamicalSystemsBase = "^1.3"
DynamicalSystemsBase = "^2.0"
HypothesisTests = "0.8, 1, 0.10"
Interpolations = "^0.12, ^1, 0.13"
IntervalArithmetic = "^0.16, ^1, 0.17, 0.18"
Expand Down
4 changes: 3 additions & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
DocumenterMarkdown = "997ab1e6-3595-5248-9280-8efb232c3433"
Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
Interpolations = "a98d9a8b-a2ab-59e6-89dd-64a1c18fca59"
KernelDensity = "5ab0869b-81aa-558d-bb23-cbf5423bbe9b"
StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
StatsPlots = "f3b207a7-027a-5e70-b257-86293d7955fd"
Measurements = "eff96d63-e80a-5855-80a2-b1b0885c5ab7"
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"

88 changes: 36 additions & 52 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,16 @@ CI = get(ENV, "CI", nothing) == "true" || get(ENV, "GITHUB_TOKEN", nothing) !==
CI && Pkg.activate(@__DIR__)
CI && Pkg.instantiate()
CI && (ENV["GKSwstype"] = "100")

using Plots
using Documenter
using DocumenterTools
using DocumenterMarkdown
using DocumenterTools: Themes

# %% Theme stuff?

# %% Build docs
cd(@__DIR__)
ENV["JULIA_DEBUG"] = "Documenter"

using UncertainData
using Distributions
Expand All @@ -17,24 +24,9 @@ using Interpolations

PAGES = [
"index.md",
"Uncertain values" => [
"uncertain_values/uncertainvalues_overview.md",
"uncertain_values/uncertainvalues_theoreticaldistributions.md",
"uncertain_values/uncertainvalues_kde.md",
"uncertain_values/uncertainvalues_fitted.md",
"uncertain_values/uncertainvalues_certainvalue.md",
"uncertain_values/uncertainvalues_populations.md",
"uncertain_values/uncertainvalues_Measurements.md",
"uncertain_values/merging.md",
"uncertain_values/uncertainvalues_examples.md",
],
"Uncertain datasets" => [
"uncertain_datasets/uncertain_datasets_overview.md",
"uncertain_datasets/uncertain_index_dataset.md",
"uncertain_datasets/uncertain_value_dataset.md",
"uncertain_datasets/uncertain_indexvalue_dataset.md",
"uncertain_datasets/uncertain_dataset.md",
],
"uncertain_values/uncertain_values.md",
"uncertain_datasets/datasets.md",
"sampling_constraints/sampling_constraints.md",
"Uncertain statistics" => [
"Core statistics" => [
"uncertain_statistics/core_stats/core_statistics.md",
Expand All @@ -57,42 +49,34 @@ PAGES = [
"uncertain_statistics/hypothesistests/anderson_darling_test.md"
],
],
"Sampling constraints" => [
"sampling_constraints/available_constraints.md",
"sampling_constraints/constrain_uncertain_values.md",
"sampling_constraints/sequential_constraints.md"
],

"Binning" => [
"binning/bin.md"
],
"Resampling" => [
"resampling/resampling_overview.md",
"resampling/resampling_uncertain_values.md",
"resampling/resampling_uncertain_datasets.md",
"resampling/resampling_uncertain_indexvalue_datasets.md",

"resampling/sequential/resampling_uncertaindatasets_sequential.md",
"resampling/sequential/resampling_indexvalue_sequential.md",
"resampling/sequential/strictly_increasing.md",
"resampling/sequential/strictly_decreasing.md",

"resampling/interpolation/interpolation.md",
"resampling/interpolation/gridded.md",
"resampling/resampling_schemes/resampling_schemes_uncertain_value_collections.md",
"resampling/resampling_schemes/resampling_schemes_uncertain_indexvalue_collections.md",
"resampling/resampling_schemes/resampling_with_schemes_uncertain_value_collections.md",
"resampling/resampling_schemes/resampling_with_schemes_uncertain_indexvalue_collections.md",
"resampling/resampling_inplace.md"
#"resampling/models/resampling_with_models.md"
],
"resampling_and_binning.md",
# "Resampling" => [
# "resampling/resampling_overview.md",
# "resampling/resampling_uncertain_values.md",
# "resampling/resampling_uncertain_datasets.md",
# "resampling/resampling_uncertain_indexvalue_datasets.md",

# "resampling/sequential/resampling_uncertaindatasets_sequential.md",
# "resampling/sequential/resampling_indexvalue_sequential.md",
# "resampling/sequential/strictly_increasing.md",
# "resampling/sequential/strictly_decreasing.md",

# "resampling/interpolation/interpolation.md",
# "resampling/interpolation/gridded.md",
# "resampling/resampling_schemes/resampling_schemes_uncertain_value_collections.md",
# "resampling/resampling_schemes/resampling_schemes_uncertain_indexvalue_collections.md",
# "resampling/resampling_schemes/resampling_with_schemes_uncertain_value_collections.md",
# "resampling/resampling_schemes/resampling_with_schemes_uncertain_indexvalue_collections.md",
# "resampling/resampling_inplace.md"
# #"resampling/models/resampling_with_models.md"
# ],

"Propagation of errors" => [
"propagation_of_errors/propagation_of_errors.md"
],

"Mathematics" => [
"mathematics/elementary_operations.md",
"mathematics/trig_functions.md"
],

Expand All @@ -119,14 +103,14 @@ ENV["JULIA_DEBUG"] = "Documenter"

makedocs(
modules = [UncertainData],
sitename = "UncertainData.jl documentation",
format = format = Documenter.HTML(
format = Documenter.HTML(
prettyurls = CI,
),
sitename = "UncertainData.jl",
authors = "Kristian Agasøster Haaga",
pages = PAGES
)


if CI
deploydocs(
repo = "github.com/kahaaga/UncertainData.jl.git",
Expand Down
File renamed without changes.
45 changes: 0 additions & 45 deletions docs/src/binning/bin.md
Original file line number Diff line number Diff line change
@@ -1,45 +0,0 @@
# Binning scalar values

## Bin values

```@docs
bin(left_bin_edges::AbstractRange, xs, ys)
```

```@docs
bin!(bins::Vector{AbstractVector{T}}, ::AbstractRange{T}, xs, ys) where T
```

## Bin summaries

```@docs
bin(f::Function, left_bin_edges::AbstractRange, xs, ys)
```

## Fast bin summaries

```@docs
bin_mean
```

# Binning uncertain data

## Bin values

```@docs
bin(x::AbstractUncertainIndexValueDataset, binning::BinnedResampling{RawValues})
```

```@docs
bin(x::AbstractUncertainIndexValueDataset, binning::BinnedWeightedResampling{RawValues})
```

## Bin summaries

```@docs
bin(x::AbstractUncertainIndexValueDataset, binning::BinnedResampling)
```

```@docs
bin(x::AbstractUncertainIndexValueDataset, binning::BinnedWeightedResampling)
```
97 changes: 0 additions & 97 deletions docs/src/mathematics/elementary_operations.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/src/resampling/resampling_uncertain_values.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,5 @@
# Resampling uncertain values

Uncertain values may be resampled by drawing random number from the distributions
furnishing them.

## Documentation

```@docs
resample(uv::AbstractUncertainValue)
```

```@docs
resample(uv::AbstractUncertainValue, n::Int)
```

## Examples

``` julia tab="Resample once"
Expand Down
9 changes: 3 additions & 6 deletions docs/src/resampling/sequential/strictly_decreasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,12 @@ The default constructor for a strictly decreasing sequential sampling constraint
## Documentation

```@docs
resample(udata::AbstractUncertainValueDataset,
constraint::Union{SamplingConstraint, Vector{SamplingConstraint}},
sequential_constraint::StrictlyDecreasing{OrderedSamplingAlgorithm};
quantiles = [0.0001, 0.9999])
resample(udata::AbstractUncertainValueDataset, sequential_constraint::StrictlyDecreasing{OrderedSamplingAlgorithm},
constraint::Union{SamplingConstraint, Vector{SamplingConstraint}})
```

```@docs
resample(udata::DT, sequential_constraint::StrictlyDecreasing{T};
quantiles = [0.0001, 0.9999]) where {DT <: AbstractUncertainValueDataset, T <: StartToEnd}
resample(udata::DT, sequential_constraint::StrictlyDecreasing{T}) where {DT <: AbstractUncertainValueDataset, T <: StartToEnd}
```

## Compatible ordering algorithms
Expand Down
Loading