Skip to content

Commit

Permalink
Fix docs (v2)
Browse files Browse the repository at this point in the history
  • Loading branch information
aronwalsh committed Jul 5, 2024
1 parent 8e6b68a commit fa22e38
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ makedocs(
format = Documenter.HTML(
prettyurls = get(ENV, "CI", nothing) == "true"
),
checkdocs = :none, # Disable strict checking for missing docstrings
modules = [CarrierCapture],
pages = [
"Home" => "index.md",
Expand Down
6 changes: 3 additions & 3 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,11 @@ In addition, the alignment of energy surfaces for defects in different charge st

The following examples are provided to illustrate some of the applications of these codes. The input data has been generated from density functional theory (DFT) using [VASP](https://www.vasp.at), but the framework can easily be adapted to accept output from other electronic structure calculators.

* [Sn<sub>Zn</sub> in Cu<sub>2</sub>ZnSnS<sub>4</sub>](./example/notebook/Harmonic%20(Sn_Zn).ipynb): Harmonic approximation
* [Sn<sub>Zn</sub> in Cu<sub>2</sub>ZnSnS<sub>4</sub>](https://github.com/WMD-group/CarrierCapture.jl/blob/master/example/notebook/Harmonic%20(Sn_Zn).ipynb): Harmonic approximation

* [DX-center in GaAs](./example/notebook/Anharmonic%20(DX%20center).ipynb): Anharmonic fitting
* [DX-center in GaAs](https://github.com/WMD-group/CarrierCapture.jl/blob/master/example/notebook/Anharmonic%20(DX%20center).ipynb): Anharmonic fitting

* [Electron-phonon coupling](./example/notebook/e-ph.ipynb): Electron-phonon coupling matrix element
* [Electron-phonon coupling](https://github.com/WMD-group/CarrierCapture.jl/blob/master/example/notebook/e-ph.ipynb): Electron-phonon coupling matrix element

## Theory

Expand Down

0 comments on commit fa22e38

Please sign in to comment.