initialize doc

ISSMteam · Apr 9, 2024 · ad2f00e · ad2f00e
1 parent 21ab40b
commit ad2f00e
Show file tree

Hide file tree

Showing 6 changed files with 90 additions and 71 deletions.
diff --git a/docs/api/pinnicle.rst b/docs/api/pinnicle.rst
@@ -0,0 +1,43 @@
+pinnicle
+=======
+
+pinnicle.domain module
+------------------------
+
+.. automodule:: pinnicle.domain
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pinnicle.modeldata module
+---------------------
+
+.. automodule:: pinnicle.modeldata
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pinnicle.nn module
+---------------------
+
+.. automodule:: pinnicle.nn
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pinnicle.physics module
+----------------------
+
+.. automodule:: pinnicle.physics
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pinnicle.utils module
+--------------------
+
+.. automodule:: pinnicle.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/source/conf.py → docs/conf.py b/docs/source/conf.py → docs/conf.py
@@ -1,13 +1,16 @@
 # Configuration file for the Sphinx documentation builder.
+from importlib.metadata import version
 
 # -- Project information
 
-project = 'Lumache'
-copyright = '2021, Graziella'
-author = 'Graziella'
+project = 'PINNICLE'
+copyright = '2024, Cheng Gong'
+author = 'Cheng Gong'
 
-release = '0.1'
-version = '0.1.0'
+# The short X.Y version
+version = version("PINNICLE")
+# The full version, including alpha/beta/rc tags
+release = version
 
 # -- General configuration
 
@@ -27,9 +30,9 @@
 
 templates_path = ['_templates']
 
-# -- Options for HTML output
+# The master toctree
+master_doc = "index"
 
+# -- Options for HTML output
 html_theme = 'sphinx_rtd_theme'
 
-# -- Options for EPUB output
-epub_show_urls = 'footnote'
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,36 @@
+PINNICLE
+===================================
+
+`PINNICLE<https://github.com/enigne/PINNICLE>` is a Python library for solving ice sheet modeling problems using a unified framework with Physics Informed Neural Networks
+
+
+Check out the :doc:`usage` section for further information, including
+how to :ref:`installation` the project.
+
+.. note::
+
+   This project is under active development.
+
+User guide
+--------
+
+.. toctree::
+   :maxdepth: 2
+
+
+API reference
+--------
+
+.. toctree::
+   :maxdepth: 2
+   :caption: API
+
+   api/pinnicle
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/source/api.rst b/docs/source/api.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
diff --git a/docs/source/usage.rst b/docs/source/usage.rst