diff --git a/README.md b/README.md index 45d9fd881..931f1ab59 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,6 @@ You can use Skyplane to transfer data: # Getting started ## Installation - We recommend installation from PyPi: `pip install skyplane` *Installation on M1 Mac*: If you are using an M1 Mac with the arm64 architecture, you will need to install Skyplane as follows diff --git a/docs/_static/social-media-banner.png b/docs/_static/social-media-banner.png new file mode 100755 index 000000000..ec5280abc Binary files /dev/null and b/docs/_static/social-media-banner.png differ diff --git a/docs/conf.py b/docs/conf.py index 9e7b3b81a..a5383a9a1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -42,6 +42,7 @@ "sphinx.ext.viewcode", "sphinx.ext.napoleon", "sphinx_autodoc_typehints", + "sphinxext.opengraph", "sphinx_click", "myst_parser", # 'matplotlib.sphinxext.plot_directive', @@ -78,10 +79,11 @@ # a list of builtin themes. html_theme = "furo" html_theme_options = {"light_logo": "logo-light-mode.png", "dark_logo": "logo-dark-mode.png", "sidebar_hide_name": True} -# html_logo = "_static/logo-light-mode.png" html_favicon = "_static/favicon.ico" html_static_path = ["_static"] +ogp_site_url = "https://skyplane.org/" +ogp_image = "_static/social-media-banner.png" # -- Options for EPUB output epub_show_urls = "footnote" diff --git a/docs/requirements.txt b/docs/requirements.txt index 09bdf0e1b..1f082deb2 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,11 +1,12 @@ -sphinx>=4.4,!=5.1 -sphinx-click -sphinx_rtd_theme +docutils furo +jupyter-sphinx +myst-nb +sphinx_rtd_theme sphinx-autobuild sphinx-autodoc-typehints +sphinx-click sphinx-copybutton -jupyter-sphinx -myst-nb -docutils +sphinx>=4.4,!=5.1 +sphinxext.opengraph .[solver,gateway] \ No newline at end of file