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.

Sign up for GitHub

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

Jump to bottom

Fix docs simple example #84

Merged
merged 2 commits into from
Sep 26, 2024
Merged

Fix docs simple example #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
65926f4
Ensure the docs build breaks on warnings
mhvk Sep 26, 2024
9a89a94
Fix simple_figure for ConjugateSpectrum simplification
mhvk Sep 26, 2024
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
5 changes: 5 additions & 0 deletions .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ build:
apt_packages:
- graphviz

sphinx:
builder: html
configuration: docs/conf.py
fail_on_warning: true

python:
install:
- method: pip
Expand Down
9 changes: 3 additions & 6 deletions docs/background/example_figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,9 @@ def simple_figure(th_par, magnification,
dynspec = np.abs(dynwave)**2

# Create conjugate and then secondary spectrum
cs = ConjugateSpectrum.from_dynamic_spectrum(dynspec, f=f, t=t, noise=0.,
d_eff=d_eff, mu_eff=mu_eff,
theta=th_par,
magnification=magnification)
tau = cs.tau
fd = cs.fd
cs = ConjugateSpectrum.from_dynamic_spectrum(dynspec, f=f, t=t, noise=0.)
tau = cs.tau << u.us
fd = cs.fd << u.mHz
secspec = cs.secspec

# Create dynamic wavefield
Expand Down