Changed to mkdocs and markdown.

arkottke · Feb 5, 2024 · df8a45a · df8a45a
1 parent 4f186dc
commit df8a45a
Show file tree

Hide file tree

Showing 40 changed files with 1,170 additions and 0 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/advanced-usage.rst b/docs/advanced-usage.rst
@@ -0,0 +1,18 @@
+Advanced usage
+==============
+
+.. currentmodule:: pyrvt.peak_calculators
+
+.. autosummary::
+   :toctree: generated/
+
+    Vanmarcke1975
+    Davenport1964
+    DerKiureghian1985
+    ToroMcGuire1987
+    CartwrightLonguetHiggins1956
+    BooreJoyner1984
+    LiuPezeshk1999
+    BooreThompson2012
+    BooreThompson2015
+    WangRathje2018
diff --git a/docs/authors.md b/docs/authors.md
@@ -0,0 +1 @@
+--8<-- "CHANGELOG.md"
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -0,0 +1 @@
+--8<-- "CHANGELOG.md"
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -0,0 +1 @@
+--8<-- "CONTRIBUTING.md"
diff --git a/docs/coverage.md b/docs/coverage.md
diff --git a/docs/credits.md b/docs/credits.md
diff --git a/docs/generated/pyrvt.peak_calculators.BooreJoyner1984.rst b/docs/generated/pyrvt.peak_calculators.BooreJoyner1984.rst
@@ -0,0 +1,33 @@
+pyrvt.peak\_calculators.BooreJoyner1984
+=======================================
+
+.. currentmodule:: pyrvt.peak_calculators
+
+.. autoclass:: BooreJoyner1984
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~BooreJoyner1984.__init__
+      ~BooreJoyner1984.limited_num_zero_crossings
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~BooreJoyner1984.ABBREV
+      ~BooreJoyner1984.NAME
+      ~BooreJoyner1984.abbrev
+      ~BooreJoyner1984.min_zero_crossings
+      ~BooreJoyner1984.name
+
+
diff --git a/docs/generated/pyrvt.peak_calculators.BooreThompson2012.rst b/docs/generated/pyrvt.peak_calculators.BooreThompson2012.rst
@@ -0,0 +1,33 @@
+pyrvt.peak\_calculators.BooreThompson2012
+=========================================
+
+.. currentmodule:: pyrvt.peak_calculators
+
+.. autoclass:: BooreThompson2012
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~BooreThompson2012.__init__
+      ~BooreThompson2012.limited_num_zero_crossings
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~BooreThompson2012.ABBREV
+      ~BooreThompson2012.NAME
+      ~BooreThompson2012.abbrev
+      ~BooreThompson2012.min_zero_crossings
+      ~BooreThompson2012.name
+
+
diff --git a/docs/generated/pyrvt.peak_calculators.BooreThompson2015.rst b/docs/generated/pyrvt.peak_calculators.BooreThompson2015.rst
@@ -0,0 +1,34 @@
+pyrvt.peak\_calculators.BooreThompson2015
+=========================================
+
+.. currentmodule:: pyrvt.peak_calculators
+
+.. autoclass:: BooreThompson2015
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~BooreThompson2015.__init__
+      ~BooreThompson2015.limited_num_zero_crossings
+      ~BooreThompson2015.nonstationarity_factor
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~BooreThompson2015.ABBREV
+      ~BooreThompson2015.NAME
+      ~BooreThompson2015.abbrev
+      ~BooreThompson2015.min_zero_crossings
+      ~BooreThompson2015.name
+
+
diff --git a/docs/generated/pyrvt.peak_calculators.CartwrightLonguetHiggins1956.rst b/docs/generated/pyrvt.peak_calculators.CartwrightLonguetHiggins1956.rst
@@ -0,0 +1,33 @@
+pyrvt.peak\_calculators.CartwrightLonguetHiggins1956
+====================================================
+
+.. currentmodule:: pyrvt.peak_calculators
+
+.. autoclass:: CartwrightLonguetHiggins1956
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~CartwrightLonguetHiggins1956.__init__
+      ~CartwrightLonguetHiggins1956.limited_num_zero_crossings
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~CartwrightLonguetHiggins1956.ABBREV
+      ~CartwrightLonguetHiggins1956.NAME
+      ~CartwrightLonguetHiggins1956.abbrev
+      ~CartwrightLonguetHiggins1956.min_zero_crossings
+      ~CartwrightLonguetHiggins1956.name
+
+
diff --git a/docs/generated/pyrvt.peak_calculators.Davenport1964.rst b/docs/generated/pyrvt.peak_calculators.Davenport1964.rst
@@ -0,0 +1,34 @@
+pyrvt.peak\_calculators.Davenport1964
+=====================================
+
+.. currentmodule:: pyrvt.peak_calculators
+
+.. autoclass:: Davenport1964
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Davenport1964.__init__
+      ~Davenport1964.asymtotic_approx
+      ~Davenport1964.limited_num_zero_crossings
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~Davenport1964.ABBREV
+      ~Davenport1964.NAME
+      ~Davenport1964.abbrev
+      ~Davenport1964.min_zero_crossings
+      ~Davenport1964.name
+
+
diff --git a/docs/generated/pyrvt.peak_calculators.DerKiureghian1985.rst b/docs/generated/pyrvt.peak_calculators.DerKiureghian1985.rst
@@ -0,0 +1,34 @@
+pyrvt.peak\_calculators.DerKiureghian1985
+=========================================
+
+.. currentmodule:: pyrvt.peak_calculators
+
+.. autoclass:: DerKiureghian1985
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~DerKiureghian1985.__init__
+      ~DerKiureghian1985.asymtotic_approx
+      ~DerKiureghian1985.limited_num_zero_crossings
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~DerKiureghian1985.ABBREV
+      ~DerKiureghian1985.NAME
+      ~DerKiureghian1985.abbrev
+      ~DerKiureghian1985.min_zero_crossings
+      ~DerKiureghian1985.name
+
+
diff --git a/docs/generated/pyrvt.peak_calculators.LiuPezeshk1999.rst b/docs/generated/pyrvt.peak_calculators.LiuPezeshk1999.rst
@@ -0,0 +1,33 @@
+pyrvt.peak\_calculators.LiuPezeshk1999
+======================================
+
+.. currentmodule:: pyrvt.peak_calculators
+
+.. autoclass:: LiuPezeshk1999
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~LiuPezeshk1999.__init__
+      ~LiuPezeshk1999.limited_num_zero_crossings
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~LiuPezeshk1999.ABBREV
+      ~LiuPezeshk1999.NAME
+      ~LiuPezeshk1999.abbrev
+      ~LiuPezeshk1999.min_zero_crossings
+      ~LiuPezeshk1999.name
+
+
diff --git a/docs/generated/pyrvt.peak_calculators.ToroMcGuire1987.rst b/docs/generated/pyrvt.peak_calculators.ToroMcGuire1987.rst
@@ -0,0 +1,34 @@
+pyrvt.peak\_calculators.ToroMcGuire1987
+=======================================
+
+.. currentmodule:: pyrvt.peak_calculators
+
+.. autoclass:: ToroMcGuire1987
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~ToroMcGuire1987.__init__
+      ~ToroMcGuire1987.asymtotic_approx
+      ~ToroMcGuire1987.limited_num_zero_crossings
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~ToroMcGuire1987.ABBREV
+      ~ToroMcGuire1987.NAME
+      ~ToroMcGuire1987.abbrev
+      ~ToroMcGuire1987.min_zero_crossings
+      ~ToroMcGuire1987.name
+
+
diff --git a/docs/generated/pyrvt.peak_calculators.Vanmarcke1975.rst b/docs/generated/pyrvt.peak_calculators.Vanmarcke1975.rst
@@ -0,0 +1,34 @@
+pyrvt.peak\_calculators.Vanmarcke1975
+=====================================
+
+.. currentmodule:: pyrvt.peak_calculators
+
+.. autoclass:: Vanmarcke1975
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Vanmarcke1975.__init__
+      ~Vanmarcke1975.limited_num_zero_crossings
+      ~Vanmarcke1975.nonstationarity_factor
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~Vanmarcke1975.ABBREV
+      ~Vanmarcke1975.NAME
+      ~Vanmarcke1975.abbrev
+      ~Vanmarcke1975.min_zero_crossings
+      ~Vanmarcke1975.name
+
+
diff --git a/docs/generated/pyrvt.peak_calculators.WangRathje2018.rst b/docs/generated/pyrvt.peak_calculators.WangRathje2018.rst
@@ -0,0 +1,35 @@
+pyrvt.peak\_calculators.WangRathje2018
+======================================
+
+.. currentmodule:: pyrvt.peak_calculators
+
+.. autoclass:: WangRathje2018
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~WangRathje2018.__init__
+      ~WangRathje2018.limited_num_zero_crossings
+      ~WangRathje2018.nonstationarity_factor
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~WangRathje2018.ABBREV
+      ~WangRathje2018.COEFS
+      ~WangRathje2018.NAME
+      ~WangRathje2018.abbrev
+      ~WangRathje2018.min_zero_crossings
+      ~WangRathje2018.name
+
+