diff options
| author |  David Grote <grote1@llnl.gov>
| 2022-10-02 14:23:46 -0700 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2022-10-02 14:23:46 -0700 |
| commit | 45ec9e3550755f375a6564ae03b90bc323e15abc (patch) | |
| tree | 60ee72923d859fbc68b68daabb68ace4bf0a4076 /Source/Utils/WarpXUtil.cpp | |
| parent | 3d0f943371ed67cf2414afc5eed84e06d1a1beb7 (diff) | |
| download | WarpX-45ec9e3550755f375a6564ae03b90bc323e15abc.tar.gz WarpX-45ec9e3550755f375a6564ae03b90bc323e15abc.tar.zst WarpX-45ec9e3550755f375a6564ae03b90bc323e15abc.zip | |
Major update of the Python/picmi documentation (#3329)
* Include WarpX specific documentation
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Undo the precommit change of import in __init__.py
* Docs: Install Pure Python WarpX PICMI
Allows to use these classes in our Sphinx autodocs in the manual.
* Sphinx: Add Napoleon Extension
https://sphinxcontrib-napoleon.readthedocs.io
* PICMI Doc Strings: Fix Some Warnings
* Removed the DocumentedMetaClass since it was moved to picmistandard
* Defined the languate in Docs/source/conf.py
* Cleaned up minor issues in the rst files
* Updated existing doc strings in picmi.py
* Reformatted doc strings in Regression/Checksum/checksumAPI.py
* Reformatted doc strings in Regression/Checksum
* First set of WarpX specific documentation
* Updated to picmistandard version 0.0.20
* Cleaned up the Python document page
Fixed up the text to be more clear.
Added section headers for each picmi class (for easy reference).
* Further updates to picmi.py doc strings
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>
Diffstat (limited to 'Source/Utils/WarpXUtil.cpp')
0 files changed, 0 insertions, 0 deletions