Skip to content

Commit

Permalink
Formatter, take 2
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisRackauckas committed Jun 26, 2022
1 parent 04ab922 commit 8af7ad9
Show file tree
Hide file tree
Showing 83 changed files with 14,333 additions and 12,660 deletions.
1 change: 1 addition & 0 deletions .JuliaFormatter.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
style = "sciml"
42 changes: 42 additions & 0 deletions .github/workflows/FormatCheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: format-check

on:
push:
branches:
- 'master'
- 'release-'
tags: '*'
pull_request:

jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
matrix:
julia-version: [1]
julia-arch: [x86]
os: [ubuntu-latest]
steps:
- uses: julia-actions/setup-julia@latest
with:
version: ${{ matrix.julia-version }}

- uses: actions/checkout@v1
- name: Install JuliaFormatter and format
# This will use the latest version by default but you can set the version like so:
#
# julia -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter", version="0.13.0"))'
run: |
julia -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter"))'
julia -e 'using JuliaFormatter; format(".", verbose=true)'
- name: Format check
run: |
julia -e '
out = Cmd(`git diff --name-only`) |> read |> String
if out == ""
exit(0)
else
@error "Some files have not been formatted !!!"
write(stdout, out)
exit(1)
end'
29 changes: 11 additions & 18 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,22 @@ using Plots

include("pages.jl")

makedocs(
sitename = "SciMLSensitivity.jl",
authors="Chris Rackauckas et al.",
clean = true,
doctest = false,
modules = [SciMLSensitivity],

strict = [
makedocs(sitename = "SciMLSensitivity.jl",
authors = "Chris Rackauckas et al.",
clean = true,
doctest = false,
modules = [SciMLSensitivity],
strict = [
:doctest,
:linkcheck,
:parse_error,
:example_block,
# Other available options are
# :autodocs_block, :cross_references, :docs_block, :eval_block, :example_block, :footnote, :meta_block, :missing_docs, :setup_block
],
format = Documenter.HTML(assets = ["assets/favicon.ico"],
canonical = "https://sensitivity.sciml.ai/stable/"),
pages = pages)

format = Documenter.HTML(#analytics = "",
assets = ["assets/favicon.ico"],
canonical="https://sensitivity.sciml.ai/stable/"),
pages=pages
)

deploydocs(
repo = "github.com/SciML/SciMLSensitivity.jl.git";
push_preview = true
)
deploydocs(repo = "github.com/SciML/SciMLSensitivity.jl.git";
push_preview = true)
96 changes: 35 additions & 61 deletions docs/pages.jl
Original file line number Diff line number Diff line change
@@ -1,62 +1,36 @@
pages = [
"SciMLSensitivity.jl: Automatic Differentiation and Adjoints for (Differential) Equation Solvers" => "index.md",
"Tutorials" => Any[
"Differentiating Ordinary Differential Equations (ODE) Tutorials" => Any[
"ad_examples/differentiating_ode.md",
"ad_examples/direct_sensitivity.md",
"ad_examples/adjoint_continuous_functional.md",
"ad_examples/chaotic_ode.md",
],
"Fitting Ordinary Differential Equation (ODE) Tutorials" => Any[
"ode_fitting/optimization_ode.md",
"ode_fitting/stiff_ode_fit.md",
"ode_fitting/exogenous_input.md",
"ode_fitting/data_parallel.md",
"ode_fitting/prediction_error_method.md",
"ode_fitting/second_order_adjoints.md",
"ode_fitting/second_order_neural.md",
],
"Training Techniques and Tips" => Any[
"training_tips/local_minima.md",
"training_tips/divergence.md",
"training_tips/multiple_nn.md",
],
"Neural Ordinary Differential Equation (Neural ODE) Tutorials" => Any[
"neural_ode/neural_ode_flux.md",
"neural_ode/neural_gde.md",
"neural_ode/minibatch.md",
],
"Stochastic Differential Equation (SDE) Tutorials" => Any[
"sde_fitting/optimization_sde.md",
],
"Delay Differential Equation (DDE) Tutorials" => Any[
"dde_fitting/delay_diffeq.md",
],
"Differential-Algebraic Equation (DAE) Tutorials" => Any[
"dae_fitting/physical_constraints.md",
],
"Partial Differential Equation (PDE) Tutorials" => Any[
"pde_fitting/pde_constrained.md",
],
"Hybrid and Jump Equation Tutorials" => Any[
"hybrid_jump_fitting/hybrid_diffeq.md",
"hybrid_jump_fitting/bouncing_ball.md",
],
"Bayesian Estimation Tutorials" => Any[
"bayesian/turing_bayesian.md",
],
"Optimal and Model Predictive Control Tutorials" => Any[
"optimal_control/optimal_control.md",
"optimal_control/feedback_control.md",
"optimal_control/SDE_control.md",
],
],
"Manual and APIs" => Any[
"manual/differential_equation_sensitivities.md",
"manual/nonlinear_solve_sensitivities.md",
"manual/direct_forward_sensitivity.md",
"manual/direct_adjoint_sensitivities.md",
],
"Benchmarks" => "Benchmark.md",
"Sensitivity Math Details" => "sensitivity_math.md",
]
"SciMLSensitivity.jl: Automatic Differentiation and Adjoints for (Differential) Equation Solvers" => "index.md",
"Tutorials" => Any["Differentiating Ordinary Differential Equations (ODE) Tutorials" => Any["ad_examples/differentiating_ode.md",
"ad_examples/direct_sensitivity.md",
"ad_examples/adjoint_continuous_functional.md",
"ad_examples/chaotic_ode.md"],
"Fitting Ordinary Differential Equation (ODE) Tutorials" => Any["ode_fitting/optimization_ode.md",
"ode_fitting/stiff_ode_fit.md",
"ode_fitting/exogenous_input.md",
"ode_fitting/data_parallel.md",
"ode_fitting/prediction_error_method.md",
"ode_fitting/second_order_adjoints.md",
"ode_fitting/second_order_neural.md"],
"Training Techniques and Tips" => Any["training_tips/local_minima.md",
"training_tips/divergence.md",
"training_tips/multiple_nn.md"],
"Neural Ordinary Differential Equation (Neural ODE) Tutorials" => Any["neural_ode/neural_ode_flux.md",
"neural_ode/neural_gde.md",
"neural_ode/minibatch.md"],
"Stochastic Differential Equation (SDE) Tutorials" => Any["sde_fitting/optimization_sde.md"],
"Delay Differential Equation (DDE) Tutorials" => Any["dde_fitting/delay_diffeq.md"],
"Differential-Algebraic Equation (DAE) Tutorials" => Any["dae_fitting/physical_constraints.md"],
"Partial Differential Equation (PDE) Tutorials" => Any["pde_fitting/pde_constrained.md"],
"Hybrid and Jump Equation Tutorials" => Any["hybrid_jump_fitting/hybrid_diffeq.md",
"hybrid_jump_fitting/bouncing_ball.md"],
"Bayesian Estimation Tutorials" => Any["bayesian/turing_bayesian.md"],
"Optimal and Model Predictive Control Tutorials" => Any["optimal_control/optimal_control.md",
"optimal_control/feedback_control.md",
"optimal_control/SDE_control.md"]],
"Manual and APIs" => Any["manual/differential_equation_sensitivities.md",
"manual/nonlinear_solve_sensitivities.md",
"manual/direct_forward_sensitivity.md",
"manual/direct_adjoint_sensitivities.md"],
"Benchmarks" => "Benchmark.md",
"Sensitivity Math Details" => "sensitivity_math.md",
]
Loading

0 comments on commit 8af7ad9

Please sign in to comment.