Skip to content

Commit

Permalink
Fix API docs (#305)
Browse files Browse the repository at this point in the history
The API docs were blank because the new dependencies from #275 were missing in the ReadTheDocs build.

The badge on the front page was not showing the failure. This is because the failed imports are treated as warnings instead of errors. So I also added fail_on_warning: true to the config and fixed all of the remaining warnings so that there is at least some indication that the build is failing if this happens again in the future.
  • Loading branch information
NikoOinonen authored Sep 23, 2024
1 parent 0ee94bc commit 0f18cad
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 6 deletions.
1 change: 1 addition & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ build:

sphinx:
configuration: doc/sphinx/source/conf.py
fail_on_warning: true

python:
install:
Expand Down
3 changes: 3 additions & 0 deletions doc/sphinx/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,6 @@ ase
sphinx==7.2.6
furo==2023.9.10
myst-parser
pydantic
toml
PyQt5
12 changes: 6 additions & 6 deletions ppafm/fieldFFT.py
Original file line number Diff line number Diff line change
Expand Up @@ -350,9 +350,9 @@ def potential2forces_mem(V, lvec, nDim, sigma=0.7, rho=None, multipole=None, doF

def Average_surf(Val_surf, W_surf, W_tip):
"""
Int_r Val_surf(r+R) W_tip(r) W_sample(r+R) W_tip) * (Val_surf W_sample)
<F>(R) = ----------------------------------------- = -----------------------------; where * means convolution
Int_r W_tip(r) W_sample(r+R) W_tip * W_sample
| Int_r Val_surf(r+R) W_tip(r) W_sample(r+R) W_tip) * (Val_surf W_sample)
| <F>(R) = ----------------------------------------- = -----------------------------; where * means convolution
| Int_r W_tip(r) W_sample(r+R) W_tip * W_sample
"""
if verbose > 0:
print("Forward FFT ")
Expand Down Expand Up @@ -384,9 +384,9 @@ def Average_surf(Val_surf, W_surf, W_tip):

def Average_tip(Val_tip, W_surf, W_tip):
"""
Int_r Val_tip(r) W_tip(r) W_sample(r+R) (Val_tip W_tip) * W_sample
<F>(R) = ----------------------------------------- = -----------------------------; where * means convolution
Int_r W_surf(r) W_sample(r+R) W_tip * W_sample
| Int_r Val_tip(r) W_tip(r) W_sample(r+R) (Val_tip W_tip) * W_sample
| <F>(R) = ----------------------------------------- = -----------------------------; where * means convolution
| Int_r W_surf(r) W_sample(r+R) W_tip * W_sample
"""
if verbose > 0:
print("Forward FFT ")
Expand Down

0 comments on commit 0f18cad

Please sign in to comment.