update with main docs #patch

README.rst

@@ -34,10 +34,10 @@ RHEED-Learn
 ===========
 
 
-    Add a short description here!
+    RHEED-Learn is a Python package for analyzing and visualizing Reflection High-Energy Electron Diffraction (RHEED) data, designed to streamline the processing of thin-film growth data and assist with materials characterization.
 
 
-A longer description of your project goes here...
+RHEED-Learn is a dedicated Python package for researchers and scientists working with Reflection High-Energy Electron Diffraction (RHEED) data, commonly used in thin-film growth analysis and materials science. The package provides an array of tools to process, visualize, and analyze RHEED data, making it easier to track film growth dynamics and extract meaningful insights from complex diffraction patterns. With capabilities to handle raw RHEED intensity oscillation data, kinematic analysis, and more, RHEED-Learn allows users to better understand growth modes, surface roughness, and lattice structures in various material systems. This package aims to facilitate reproducible research by offering modular functions, supporting customized analyses, and providing integration with other Python data analysis workflows. Ideal for both routine RHEED characterization and advanced studies, RHEED-Learn empowers researchers to push forward in the field of materials synthesis and thin-film research.
 
 
 .. _pyscaffold-notes:

docs/conf.py

@@ -74,6 +74,10 @@
     "sphinx.ext.napoleon",
 ]
 
+# Generate summary tables automatically
+autosummary_generate = True
+
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
@@ -88,7 +92,7 @@
 
 # General information about the project.
 project = "RHEED-Learn"
-copyright = "2024, Yichen Guo"
+copyright = "2024, Joshua C. Agar"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -106,7 +110,7 @@
 if not version or version.lower() == "unknown":
     version = os.getenv("READTHEDOCS_VERSION", "unknown")  # automatically set by RTD
 
-release = version
+release = version[:6]
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -134,7 +138,7 @@
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-# show_authors = False
+show_authors = True
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "sphinx"
@@ -153,14 +157,43 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = "alabaster"
+html_theme = "pydata_sphinx_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
+# Material theme options (see theme.conf for more information)
 html_theme_options = {
-    "sidebar_width": "300px",
-    "page_width": "1200px"
+    "show_nav_level": 4,
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/m3-learning/RHEED-Learn.git",
+            "icon": "fab fa-github-square",
+            "type": "fontawesome",
+        },
+        {
+            "name": "GitLab",
+            "url": "https://gitlab.com/<your-org>/<your-repo>",
+            "icon": "fab fa-gitlab",
+            "type": "fontawesome",
+        },
+        {
+            "name": "Twitter",
+            "url": "https://twitter.com/<your-handle>",
+            "icon": "fab fa-twitter-square",
+            # The default for `type` is `fontawesome` so it is not actually required in any of the above examples as it is shown here
+        },
+        {
+            "name": "Mastodon",
+            "url": "https://<your-host>@<your-handle>",
+            "icon": "fab fa-mastodon",
+        },
+    ],
+    "logo": {
+        "image_light": "_static/Drexel_blue_Logo_square_Light.png",
+        "image_dark": "_static/Drexel_blue_Logo_square_Dark.png",
+    },
 }
 
 # Add any paths that contain custom themes here, relative to this directory.
@@ -187,9 +220,13 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
 
+html_css_files = [
+    "custom.css",
+]
+
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-# html_last_updated_fmt = '%b %d, %Y'
+html_last_updated_fmt = "%b %d, %Y"
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
@@ -246,7 +283,7 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-    ("index", "user_guide.tex", "RHEED-Learn Documentation", "Yichen Guo", "manual")
+    ("index", "user_guide.tex", "RHEED-Learn Documentation", "jagar2", "manual")
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -283,4 +320,4 @@
     "pyscaffold": ("https://pyscaffold.org/en/stable", None),
 }
 
-print(f"loading configurations for {project} {version} ...", file=sys.stderr)
+print(f"loading configurations for {project} {version} ...", file=sys.stderr)

setup.cfg

@@ -5,7 +5,7 @@
 
 [metadata]
 name = RHEED-Learn
-description = Add a short description here!
+description = RHEED-Learn is a Python package for analyzing and visualizing Reflection High-Energy Electron Diffraction (RHEED) data, designed to streamline the processing of thin-film growth data and assist with materials characterization.
 author = Yichen Guo
 author_email = [email protected]
 license = MIT