update docs

.readthedocs.yaml

@@ -9,7 +9,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.9"
+    python: "3.11"
     # You can also specify other tool versions:
     # nodejs: "19"
     # rust: "1.64"

docs/requirements.txt

@@ -1,6 +1,7 @@
 recommonmark
-sphinx
-myst-parser
-sphinxcontrib-video
-sphinx_rtd_theme
-Jinja2
+sphinx>=7
+myst-nb
+sphinx-copybutton
+sphinx-design
+pydata_sphinx_theme
+Jinja2

docs/source/conf.py

@@ -7,35 +7,70 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = 'Geo-SAM'
-copyright = '2023, Joey, Fancy'
+copyright = '2023-2024, Joey, Fancy'
 author = 'Joey, Fancy'
 release = 'v1.2'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
-    'myst_parser',
-    'sphinx.ext.autodoc',
-    'sphinxcontrib.video',
-    'sphinx.ext.doctest',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.todo',
+    # "myst_nb",
+    "myst_parser",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.todo",
+    "sphinx_copybutton",
+    "sphinx_design",
 ]
 source_suffix = {
-    '.rst': 'restructuredtext',
-    '.md': 'markdown',
+    ".rst": "restructuredtext",
+    ".md": "markdown",
 }
 
+myst_enable_extensions = ["colon_fence"]
+myst_url_schemes = ["http", "https", "mailto"]
+suppress_warnings = ["mystnb.unknown_mime_type"]
+nb_execution_mode = "off"
+autodoc_inherit_docstrings = True
 # templates_path = ['_templates']
 exclude_patterns = []
 
-
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'sphinx_rtd_theme'
+html_theme = 'pydata_sphinx_theme'
 html_static_path = ['_static']
 
+html_context = {
+    "github_url": "https://github.com",  # or your GitHub Enterprise site
+    "github_user": "coolzhao",
+    "github_repo": "Geo-SAM",
+    "github_version": "main",
+    "doc_path": "docs/source",
+}
+
+
+html_theme_options = {
+    "show_toc_level": 2,
+    "show_nav_level": 2,
+    "use_edit_page_button": True,
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/coolzhao/Geo-SAM",
+            "icon": "fa-brands fa-square-github",
+            "type": "fontawesome",
+        },
+        {
+            "name": "PyPI",
+            "url": "https://pypi.org/project/GeoSAM-Image-Encoder",
+            "icon": "fa-brands fa-python",
+            "type": "fontawesome",
+        },
+    ],
+}
+
 video_enforce_extra_source = True