Merge pull request #40 from FRBs/docs

docs improved
FRBs · Aug 21, 2024 · 1523027 · 1523027
2 parents 6ac524c + a313d32
commit 1523027
Show file tree

Hide file tree

Showing 34 changed files with 552 additions and 419 deletions.
diff --git a/docs/api/base.rst → docs/api/base.md b/docs/api/base.rst → docs/api/base.md
@@ -1,7 +1,8 @@
-sigpyproc.base
-==============
+# sigpyproc.base
 
+```{eval-rst}
 .. automodule:: sigpyproc.base
    :members:
    :undoc-members:
    :show-inheritance:
+```
diff --git a/docs/api/block.rst → docs/api/block.md b/docs/api/block.rst → docs/api/block.md
@@ -1,7 +1,8 @@
-sigpyproc.block
-===============
+# sigpyproc.block
 
+```{eval-rst}
 .. automodule:: sigpyproc.block
    :members:
    :undoc-members:
-   :show-inheritance:
+   :show-inheritance:
+```
diff --git a/docs/api/core.rst → docs/api/core.md b/docs/api/core.rst → docs/api/core.md
@@ -1,27 +1,29 @@
-sigpyproc.core module
-=====================
+# sigpyproc.core module
 
-sigpyproc.core.stats
---------------------
+## sigpyproc.core.stats
 
+```{eval-rst}
 .. automodule:: sigpyproc.core.stats
    :members:
    :undoc-members:
    :show-inheritance:
+```
 
-sigpyproc.core.rfi
---------------------
+## sigpyproc.core.rfi
 
+```{eval-rst}
 .. automodule:: sigpyproc.core.rfi
    :members:
    :undoc-members:
    :show-inheritance:
 
+```
 
-sigpyproc.core.kernels
-----------------------
+## sigpyproc.core.kernels
 
+```{eval-rst}
 .. automodule:: sigpyproc.core.kernels
    :members:
    :undoc-members:
    :show-inheritance:
+```
diff --git a/docs/api/foldedcube.rst → docs/api/foldedcube.md b/docs/api/foldedcube.rst → docs/api/foldedcube.md
@@ -1,7 +1,8 @@
-sigpyproc.foldedcube
-====================
+# sigpyproc.foldedcube
 
+```{eval-rst}
 .. automodule:: sigpyproc.foldedcube
    :members:
    :undoc-members:
    :show-inheritance:
+```
diff --git a/docs/api/fourierseries.rst → docs/api/fourierseries.md b/docs/api/fourierseries.rst → docs/api/fourierseries.md
@@ -1,7 +1,8 @@
-sigpyproc.fourierseries
-=======================
+# sigpyproc.fourierseries
 
+```{eval-rst}
 .. automodule:: sigpyproc.fourierseries
    :members:
    :undoc-members:
    :show-inheritance:
+```
diff --git a/docs/api/header.rst → docs/api/header.md b/docs/api/header.rst → docs/api/header.md
@@ -1,7 +1,8 @@
-sigpyproc.header
-================
+# sigpyproc.header
 
+```{eval-rst}
 .. automodule:: sigpyproc.header
    :members:
    :undoc-members:
    :show-inheritance:
+```
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -0,0 +1,31 @@
+# sigpyproc
+
+```{eval-rst}
+.. py:module:: sigpyproc
+
+```
+
+## Subpackages
+
+```{toctree}
+:maxdepth: 1
+
+core
+io
+```
+
+## Submodules
+
+```{toctree}
+:maxdepth: 1
+
+base
+block
+foldedcube
+fourierseries
+header
+params
+readers
+timeseries
+utils
+```
diff --git a/docs/api/io.rst → docs/api/io.md b/docs/api/io.rst → docs/api/io.md
@@ -1,34 +1,37 @@
-sigpyproc.io module
-===================
+# sigpyproc.io module
 
-sigpyproc.io.sigproc
---------------------
+## sigpyproc.io.sigproc
 
+```{eval-rst}
 .. automodule:: sigpyproc.io.sigproc
    :members:
    :undoc-members:
    :show-inheritance:
+```
 
-sigpyproc.io.bits
------------------
+## sigpyproc.io.bits
 
+```{eval-rst}
 .. automodule:: sigpyproc.io.bits
    :members:
    :undoc-members:
    :show-inheritance:
+```
 
-sigpyproc.io.fileio
--------------------
+## sigpyproc.io.fileio
 
+```{eval-rst}
 .. automodule:: sigpyproc.io.fileio
    :members:
    :undoc-members:
    :show-inheritance:
+```
 
-sigpyproc.io.pfits
--------------------
+## sigpyproc.io.pfits
 
+```{eval-rst}
 .. automodule:: sigpyproc.io.pfits
    :members:
    :undoc-members:
-   :show-inheritance:
+   :show-inheritance:
+```
diff --git a/docs/api/params.rst → docs/api/params.md b/docs/api/params.rst → docs/api/params.md
@@ -1,7 +1,8 @@
-sigpyproc.params
-================
+# sigpyproc.params
 
+```{eval-rst}
 .. automodule:: sigpyproc.params
    :members:
    :undoc-members:
    :show-inheritance:
+```
diff --git a/docs/api/readers.rst → docs/api/readers.md b/docs/api/readers.rst → docs/api/readers.md
@@ -1,7 +1,8 @@
-sigpyproc.readers
-=================
+# sigpyproc.readers
 
+```{eval-rst}
 .. automodule:: sigpyproc.readers
    :members:
    :undoc-members:
    :show-inheritance:
+```
diff --git a/docs/api/timeseries.rst → docs/api/timeseries.md b/docs/api/timeseries.rst → docs/api/timeseries.md
@@ -1,7 +1,8 @@
-sigpyproc.timeseries
-====================
+# sigpyproc.timeseries
 
+```{eval-rst}
 .. automodule:: sigpyproc.timeseries
    :members:
    :undoc-members:
    :show-inheritance:
+```
diff --git a/docs/api/utils.rst → docs/api/utils.md b/docs/api/utils.rst → docs/api/utils.md
@@ -1,7 +1,8 @@
-sigpyproc.utils
-===============
+# sigpyproc.utils
 
+```{eval-rst}
 .. automodule:: sigpyproc.utils
    :members:
    :undoc-members:
    :show-inheritance:
+```
diff --git a/docs/changes.md b/docs/changes.md
@@ -0,0 +1,5 @@
+# Changelog
+
+```{eval-rst}
+.. include:: ../HISTORY.rst
+```
diff --git a/docs/changes.rst b/docs/changes.rst
diff --git a/docs/cmd.rst → docs/cmd.md b/docs/cmd.rst → docs/cmd.md
@@ -1,18 +1,19 @@
-Command line utilities
-======================
+# Command line utilities
 
+```{eval-rst}
 .. click:: sigpyproc.apps.spp_header:main
    :prog: spp_header
    :nested: full
+```
 
-.. click:: sigpyproc.apps.spp_decimate:main
-   :prog: spp_decimate
-   :nested: full
-
+```{eval-rst}
 .. click:: sigpyproc.apps.spp_extract:main
    :prog: spp_extract
    :nested: full
+```
 
+```{eval-rst}
 .. click:: sigpyproc.apps.spp_clean:main
    :prog: spp_clean
-   :nested: full
+   :nested: full
+```