diff --git a/docs/api.rst b/docs/api.rst index 7a4c8218..72a33557 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -36,6 +36,7 @@ Reader :maxdepth: 2 modules_psm_reader + modules_pg_reader I/O diff --git a/docs/modules_pg_reader.rst b/docs/modules_pg_reader.rst new file mode 100644 index 00000000..cc27886d --- /dev/null +++ b/docs/modules_pg_reader.rst @@ -0,0 +1,17 @@ +alphabase.pg_reader +=========================== + +All pg_readers can be accessed by +:obj:`pg_reader_provider `. + +.. toctree:: + :maxdepth: 1 + + pg_reader/pg_base + pg_reader/alphadia_pg_reader + pg_reader/alphapept_pg_reader + pg_reader/diann_pg_reader + pg_reader/fragpipe_pg_reader + pg_reader/maxquant_pg_reader + pg_reader/mztab_pg_reader + pg_reader/spectronaut_pg_reader diff --git a/docs/pg_reader/alphadia_pg_reader.rst b/docs/pg_reader/alphadia_pg_reader.rst new file mode 100644 index 00000000..c4c79426 --- /dev/null +++ b/docs/pg_reader/alphadia_pg_reader.rst @@ -0,0 +1,7 @@ +alphabase.pg_reader.alphadia_pg_reader +====================================== + +.. automodule:: alphabase.pg_reader.alphadia_pg_reader + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/pg_reader/alphapept_pg_reader.rst b/docs/pg_reader/alphapept_pg_reader.rst new file mode 100644 index 00000000..e1d08593 --- /dev/null +++ b/docs/pg_reader/alphapept_pg_reader.rst @@ -0,0 +1,7 @@ +alphabase.pg_reader.alphapept_pg_reader +======================================= + +.. automodule:: alphabase.pg_reader.alphapept_pg_reader + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/pg_reader/diann_pg_reader.rst b/docs/pg_reader/diann_pg_reader.rst new file mode 100644 index 00000000..15a7d0e8 --- /dev/null +++ b/docs/pg_reader/diann_pg_reader.rst @@ -0,0 +1,7 @@ +alphabase.pg_reader.diann_pg_reader +=================================== + +.. automodule:: alphabase.pg_reader.diann_pg_reader + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/pg_reader/fragpipe_pg_reader.rst b/docs/pg_reader/fragpipe_pg_reader.rst new file mode 100644 index 00000000..fff83518 --- /dev/null +++ b/docs/pg_reader/fragpipe_pg_reader.rst @@ -0,0 +1,7 @@ +alphabase.pg_reader.fragpipe_pg_reader +====================================== + +.. automodule:: alphabase.pg_reader.fragpipe_pg_reader + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/pg_reader/maxquant_pg_reader.rst b/docs/pg_reader/maxquant_pg_reader.rst new file mode 100644 index 00000000..5744f171 --- /dev/null +++ b/docs/pg_reader/maxquant_pg_reader.rst @@ -0,0 +1,7 @@ +alphabase.pg_reader.maxquant_pg_reader +====================================== + +.. automodule:: alphabase.pg_reader.maxquant_pg_reader + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/pg_reader/mztab_pg_reader.rst b/docs/pg_reader/mztab_pg_reader.rst new file mode 100644 index 00000000..69475764 --- /dev/null +++ b/docs/pg_reader/mztab_pg_reader.rst @@ -0,0 +1,7 @@ +alphabase.pg_reader.mztab_pg_reader +====================================== + +.. automodule:: alphabase.pg_reader.mztab_pg_reader + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/pg_reader/pg_base.rst b/docs/pg_reader/pg_base.rst new file mode 100644 index 00000000..a18e1710 --- /dev/null +++ b/docs/pg_reader/pg_base.rst @@ -0,0 +1,7 @@ +alphabase.pg_reader.base +======================== + +.. automodule:: alphabase.pg_reader.pg_reader + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/pg_reader/spectronaut_pg_reader.rst b/docs/pg_reader/spectronaut_pg_reader.rst new file mode 100644 index 00000000..5bc39fca --- /dev/null +++ b/docs/pg_reader/spectronaut_pg_reader.rst @@ -0,0 +1,7 @@ +alphabase.pg_reader.spectronaut_reader +====================================== + +.. automodule:: alphabase.pg_reader.spectronaut_reader + :members: + :undoc-members: + :show-inheritance: