.. use raw html to hide the doc title show it is shows up in browser tab but not on page .. https://github.com/sphinx-doc/sphinx/issues/8356#issuecomment-1201029122 .. raw:: html
.. image:: _static/banner.jpg :alt: pyswmm banner **Date**: |today| **Version**: |version| |gh actions| |docs| |license| |pypi version| |downloads| |cite| ------------------- More information about pyswmm can be found at the `official pyswmm website`_. .. panels:: :container: container pb-4 :card: + intro-card text-center :column: col-lg-6 col-md-6 col-sm-6 col-xs-12 p-2 --- :img-top: _static/map.svg Overview ^^^^^^^^^^^^ Learn about pyswmm's ambition! +++ .. link-button:: overview :type: ref :text: Overview! :classes: btn-block btn-secondary stretched-link --- :img-top: _static/power.svg Quick Start ^^^^^^^^^^ The quick start section provides sample code snippets for various use cases of pyswmm. This is the perfect place to jump-start your own project with pyswmm. +++ .. link-button:: quickstart :type: ref :text: Quick Start! :classes: btn-block btn-secondary stretched-link --- :img-top: _static/book.svg API reference ^^^^^^^^^^^^^ The API reference provides a catalogue of all docstrings written in pyswmm. It lays out the modules, functions, and classes provided in pyswmm like and encyclopedia. +++ .. link-button:: reference/index :type: ref :text: API Reference! :classes: btn-block btn-secondary stretched-link --- :img-top: _static/coffee.svg Video Tutorials ^^^^^^^^^^^^^^^^ The pyswmm development team is putting together a video tutorial series the covers the various use cases of pyswmm. +++ .. link-button:: https://www.pyswmm.org/tutorial :text: Video Tutorials! :classes: btn-block btn-secondary stretched-link .. toctree:: :maxdepth: 2 :hidden: overview install quickstart reference/index Examples