sandialabs / WecOptTool / 32420426769

88%

main: 88%

push

github

Docs improvements (#452)

* update build process

* update smv_tag_whitelist to allow empty tags in Sphinx multiversion builds

* fetch full; also grabs branches

* use raw text for labels where appropriate

* implement git reference handling for Sphinx multiversion builds

* fix references/bibliography

* add IFAC DOI

* clean up math

* Add Jeff's realizations paper

* Autograd docs references -> Jax

* Make local docs builds more robust on Windows

Improve the local documentation build workflow, especially on Windows.

- make docs example copying idempotent in docs/source/conf.py
- add an environment-variable option to skip theory animation generation
- add an environment-variable option to skip gifsicle optimization
- make docs/clean_docs.py report cleanup failures without aborting

These changes help local doc builds succeed when generated files are
reused between Sphinx phases or when optional tools like gifsicle are
not installed.

* fixed broken jax link and indent of doc string

* fix list docstring in plot_power_flow

* PEP8 style for function signature

* Add pseudo-spectral theory visualization assets

Add a script and generated static assets for illustrating the
time/frequency equivalence used by the pseudo-spectral method.

This includes:
- a static figure showing the relationship between Fourier coefficients,
  harmonics, collocation points, and the periodic time trajectory
- a WaveBot animation showing an actual pseudo-spectral solution iterate history
- a Python script that reproduces these documentation assets

The generated files are committed so documentation builds do not depend on
external optimization-history data or additional runtime generation steps.

* static optimization data of electrical power optimization for Wavebot tut1 with wot3p2p1

* Integrate pseudo-spectral visualizations into theory docs

Update the theory documentation to include the new
time/frequency equivalence discussion and WaveBot solution animation.

This... (continued)

1 of 1 new or added line in 1 file covered. (100.0%)

1259 of 1429 relevant lines covered (88.1%)

5.28 hits per line