From 50fa37a09a1313c6b6121430ae78729ae1b7d523 Mon Sep 17 00:00:00 2001 From: Newton Ihoeghian Date: Tue, 25 Jun 2024 12:28:46 -0700 Subject: [PATCH] add changes --- docs/source/about.rst | 4 +++ docs/source/autosummary/mdgeom.data.files.rst | 23 ++++++++++++++ docs/source/autosummary/mdgeom.data.rst | 31 +++++++++++++++++++ docs/source/autosummary/mdgeom.rst | 31 +++++++++++++++++++ docs/source/getting_started.rst | 2 +- docs/source/getting_strd.rst | 1 + docs/source/index.rst | 2 ++ 7 files changed, 93 insertions(+), 1 deletion(-) create mode 100644 docs/source/about.rst create mode 100644 docs/source/autosummary/mdgeom.data.files.rst create mode 100644 docs/source/autosummary/mdgeom.data.rst create mode 100644 docs/source/autosummary/mdgeom.rst create mode 100644 docs/source/getting_strd.rst diff --git a/docs/source/about.rst b/docs/source/about.rst new file mode 100644 index 0000000..0fb334b --- /dev/null +++ b/docs/source/about.rst @@ -0,0 +1,4 @@ +About mdgeom +=============== + +The mdgeomik mdgeom was made as part of a python mdanalysis workshop \ No newline at end of file diff --git a/docs/source/autosummary/mdgeom.data.files.rst b/docs/source/autosummary/mdgeom.data.files.rst new file mode 100644 index 0000000..b3cf07c --- /dev/null +++ b/docs/source/autosummary/mdgeom.data.files.rst @@ -0,0 +1,23 @@ +mdgeom.data.files +================= + +.. automodule:: mdgeom.data.files + + + + + + + + + + + + + + + + + + + diff --git a/docs/source/autosummary/mdgeom.data.rst b/docs/source/autosummary/mdgeom.data.rst new file mode 100644 index 0000000..04a27e9 --- /dev/null +++ b/docs/source/autosummary/mdgeom.data.rst @@ -0,0 +1,31 @@ +mdgeom.data +=========== + +.. automodule:: mdgeom.data + + + + + + + + + + + + + + + + + + + +.. rubric:: Modules + +.. autosummary:: + :toctree: + :recursive: + + mdgeom.data.files + diff --git a/docs/source/autosummary/mdgeom.rst b/docs/source/autosummary/mdgeom.rst new file mode 100644 index 0000000..2ce9519 --- /dev/null +++ b/docs/source/autosummary/mdgeom.rst @@ -0,0 +1,31 @@ +mdgeom +====== + +.. automodule:: mdgeom + + + + + + + + + + + + + + + + + + + +.. rubric:: Modules + +.. autosummary:: + :toctree: + :recursive: + + mdgeom.data + diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 4c98a69..6ad346b 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -1,4 +1,4 @@ Getting Started =============== -This page details how to get started with mdgeomik. +Welcome to mdgeom package. diff --git a/docs/source/getting_strd.rst b/docs/source/getting_strd.rst new file mode 100644 index 0000000..f8c37a3 --- /dev/null +++ b/docs/source/getting_strd.rst @@ -0,0 +1 @@ +Hello, welcome. It is great to have you here. diff --git a/docs/source/index.rst b/docs/source/index.rst index 9c0cbb8..8e6bdb7 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -12,6 +12,8 @@ Welcome to mdgeomik's documentation! getting_started api + getting_strd + about