Code

Docs enhancements#235

Code

Merged

aerispaha merged 40 commits intomasterpyswmm/swmmio:masterfrom docs-enhancementspyswmm/swmmio:docs-enhancementsCopy head branch name to clipboardJan 5, 2025

+19,753-728

Commits

Commits on Dec 4, 2024

• add link to github repo in docs header

  aerispaha

  committed
  9dda51e

  Copy full SHA for 9dda51e

• add jupyter notebook support in docs, rotate model silliness

  aerispaha

  committed
  ac4698e

  Copy full SHA for ac4698e

Commits on Dec 6, 2024

• add ability to instantiate Model from a url

  aerispaha

  committed
  55240dd

  Copy full SHA for 55240dd

• started visualizing models documentation

  aerispaha

  committed
  bc2f28d

  Copy full SHA for bc2f28d

Commits on Dec 9, 2024

• refined the visualizing models docs

  aerispaha

  committed
  9670aa8

  Copy full SHA for 9670aa8

• Add spirograph docs

  aerispaha

  committed
  98a38e5

  Copy full SHA for 98a38e5

Commits on Dec 10, 2024

• added fractals to art

  aerispaha

  committed
  4ddd169

  Copy full SHA for 4ddd169

• actually added the fractal visualizations

  aerispaha

  committed
  72b1938

  Copy full SHA for 72b1938

Commits on Dec 17, 2024

• add intro, quick start, and usage guide

  aerispaha

  committed
  474b868

  Copy full SHA for 474b868

Commits on Dec 18, 2024

• fixed recusion error in sphinx build

  aerispaha

  committed
  1b58bf8

  Copy full SHA for 1b58bf8

• improved organization of docs

  aerispaha

  committed
  fa13d8e

  Copy full SHA for fa13d8e

• fixing references to source code, configuring sphinx

  aerispaha

  committed
  3e22a8b

  Copy full SHA for 3e22a8b

• fixing docstring formatting issues

  aerispaha

  committed
  b421d99

  Copy full SHA for b421d99

• refactor reference docs, split intoindividual pages for core and utils module members

  aerispaha

  committed
  c7eb049

  Copy full SHA for c7eb049

• numpy-style docstringify

  aerispaha

  committed
  6645f80

  Copy full SHA for 6645f80

• further docs refactor to split modules into separate files

  aerispaha

  committed
  2024bea

  Copy full SHA for 2024bea

• update README and fix docstrings in graphics

  aerispaha

  committed
  9ff0c0d

  Copy full SHA for 9ff0c0d

• add requests dependency

  aerispaha

  committed
  eb5bb6b

  Copy full SHA for eb5bb6b

• upgrade pyshp dependency

  aerispaha

  committed
  ec7714a

  Copy full SHA for ec7714a

• clean up config

  aerispaha

  committed
  19171a5

  Copy full SHA for 19171a5

• Merge pull request #236 from pyswmm/upgrade_pyshp

  Show description for 3d808fe
  aerispaha

  authored
  3d808fe

  Copy full SHA for 3d808fe

• moar fractal depth

  aerispaha

  committed
  a9bf164

  Copy full SHA for a9bf164

• don't cache notebooks in documentation

  aerispaha

  committed
  1183802

  Copy full SHA for 1183802

• fix typos in docs and docstring

  aerispaha

  committed
  edd0465

  Copy full SHA for edd0465

Commits on Dec 19, 2024

• shorten and fix links to reference docs on main landing page

  aerispaha

  committed
  55b810f

  Copy full SHA for 55b810f

• improvements to docstrings and doctests

  aerispaha

  committed
  9d7d55e

  Copy full SHA for 9d7d55e

• revert conduits as property

  aerispaha

  committed
  ce8ccf7

  Copy full SHA for ce8ccf7

• improve clarity of API references in getting started

  aerispaha

  committed
  4c7f769

  Copy full SHA for 4c7f769

• Added example with pyswmm and swmmio, incluiding animation

  aerispaha

  committed
  83ef132

  Copy full SHA for 83ef132

• add refernce to pyswmm example

  aerispaha

  committed
  15b419c

  Copy full SHA for 15b419c

• fix typos in pyswmm example

  aerispaha

  committed
  77b6fde

  Copy full SHA for 77b6fde

• clean up the pyswmm example a bit more

  aerispaha

  committed
  9db192b

  Copy full SHA for 9db192b

Commits on Dec 20, 2024

• fixed link to pyswmm docs, simplify animation logic

  aerispaha

  committed
  c55270e

  Copy full SHA for c55270e

Commits on Jan 2, 2025

• add requests to setup.py dependencies

  aerispaha

  committed
  5dd0ede

  Copy full SHA for 5dd0ede

• navigation improvements in visualizing models guide, readme image change

  aerispaha

  committed
  080dd0d

  Copy full SHA for 080dd0d

Commits on Jan 3, 2025

• add legend to plot and code revisions for clarity

  aerispaha

  committed
  1e2d6e2

  Copy full SHA for 1e2d6e2

• fix typo in marking art user guide

  aerispaha

  committed
  8e670d9

  Copy full SHA for 8e670d9

• refactored pyswmm example for clarity per wraseman

  aerispaha

  committed
  84abd9a

  Copy full SHA for 84abd9a

• improvements to docs, bug fix in slr example

  aerispaha

  committed
  5dc74e4

  Copy full SHA for 5dc74e4

• add typing_extensions

  aerispaha

  committed
  2a570ad

  Copy full SHA for 2a570ad