doc: include conda install command in installation guide (#235)

beckermr · web-flow · commit 84acb2bdbac5 · 2026-05-09T08:08:24.000-05:00
* doc: include conda install command in installation guide

Added conda installation instructions for jax-galsim.

* feat: add copy button to docs

Added 'sphinx-copybutton' to the documentation dependencies.

* feat: add sphinx_copybutton extension to conf.py

* Include conda install command in documentation

Add conda installation instructions for jax-galsim.
diff --git a/docs/conf.py b/docs/conf.py
@@ -50,6 +50,7 @@
     "sphinx.ext.viewcode",  # "View source" links
     "sphinx.ext.intersphinx",  # cross-links to external docs
     "sphinx_design",  # dropdown / collapsible directives
+    "sphinx_copybutton",  # copy button for code blocks
 ]
 
 templates_path = ["_templates"]
diff --git a/docs/index.rst b/docs/index.rst
@@ -66,6 +66,10 @@ Quick Install
 
    pip install jax-galsim
 
+.. code-block:: bash
+
+   conda install -c conda-forge jax-galsim
+
 See :doc:`installation` for GPU support and development setup.
 
 Minimal Example
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -8,6 +8,10 @@ Quick Install
 
    pip install jax-galsim
 
+.. code-block:: bash
+
+   conda install -c conda-forge jax-galsim
+
 This installs JAX-GalSim and its dependencies (JAX, NumPy, GalSim, Astropy).
 
 GPU Support
diff --git a/pyproject.toml b/pyproject.toml
@@ -14,7 +14,7 @@ dependencies    = ["numpy >=1.18.0", "galsim >=2.7.0", "jax >=0.6.0", "astropy >
 
 [project.optional-dependencies]
 dev  = ["pytest", "pytest-codspeed"]
-docs = ["sphinx>=7.0", "furo>=2024.1.29", "sphinx-design>=0.5"]
+docs = ["sphinx>=7.0", "furo>=2024.1.29", "sphinx-design>=0.5", "sphinx-copybutton"]
 
 [project.urls]
 home = "https://github.com/GalSim-developers/JAX-GalSim"

Original file line number	Diff line number	Diff line change
`@@ -50,6 +50,7 @@`
`50`	`50`	`"sphinx.ext.viewcode", # "View source" links`
`51`	`51`	`"sphinx.ext.intersphinx", # cross-links to external docs`
`52`	`52`	`"sphinx_design", # dropdown / collapsible directives`
	`53`	`+ "sphinx_copybutton", # copy button for code blocks`
`53`	`54`	`]`
`54`	`55`
`55`	`56`	`templates_path = ["_templates"]`