Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Denis-Titov committed Feb 24, 2024
1 parent 9e0f0c2 commit a2762ff
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 19 deletions.
14 changes: 6 additions & 8 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,17 @@ makedocs(;
modules=[EnzymeFitting],
authors="Denis Titov [email protected] and contributors",
sitename="EnzymeFitting.jl",
# remotes = Documenter.Remotes.GitHub("DenisTitovLab", "EnzymeFitting.jl"),
repo = Documenter.Remotes.GitHub("DenisTitovLab", "EnzymeFitting.jl"),
# format=Documenter.HTML(;
# canonical="https://Denis-Titov.github.io/EnzymeFitting.jl",
# edit_link="main",
# assets=String[],
# ),
format=Documenter.HTML(;
canonical="https://Denis-Titov.github.io/EnzymeFitting.jl",
edit_link="main",
assets=String[],
),
pages=[
"Home" => "index.md",
],
)

deploydocs(;
repo="github.com/DenisTitovLab/EnzymeFitting.jl.git",
devbranch="main",
# devbranch="main",
)
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ CurrentModule = EnzymeFitting

# EnzymeFitting

Documentation for [EnzymeFitting](https://github.com/Denis-Titov/EnzymeFitting.jl).
Documentation for [EnzymeFitting](https://github.com/DenisTitovLab/EnzymeFitting.jl).

```@index
```
Expand Down
20 changes: 10 additions & 10 deletions src/rate_equation_fitting.jl
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ CODE FOR RATE EQUATION FITTING
using CMAEvolutionStrategy, DataFrames, Statistics

#TODO add optimization_kwargs to control the optimization process
# """
# fit_rate_equation(
# rate_equation::Function,
# data::DataFrame,
# metab_names::Tuple,
# param_names::Tuple;
# n_iter = 20
# )
"""
fit_rate_equation(
rate_equation::Function,
data::DataFrame,
metab_names::Tuple,
param_names::Tuple;
n_iter = 20
)
# Fit `rate_equation` to `data` and report the loss and best fit parameters.
# """
Fit `rate_equation` to `data` and report the loss and best fit parameters.
"""
function fit_rate_equation(
rate_equation::Function,
data::DataFrame,
Expand Down

0 comments on commit a2762ff

Please sign in to comment.