Add conda instructions and docs scripts (#97)

* Add scripts for building the docs

* Add conda instructions

* Simplify changelog generation

Author: jtpio

.gitignore

@@ -4,3 +4,4 @@ jupyterlite_sphinx/jupyterlite_sphinx.egg-info
 docs/build
 build
 dist
+.jupyterlite.doit.db

docs/changelog.md

@@ -0,0 +1,2 @@
+```{include} ../CHANGELOG.md
+```

docs/conf.py

@@ -1,11 +1,4 @@
 # -*- coding: utf-8 -*-
-import shutil
-
-from pathlib import Path
-
-HERE = Path(__file__).parent
-ROOT = HERE.parent
-
 
 extensions = [
     'jupyterlite_sphinx',
@@ -35,7 +28,4 @@
     ]
 }
 
-# Copy the markdown file here
-shutil.copy(ROOT / "CHANGELOG.md", HERE / "changelog.md")
-
 suppress_warnings = ["myst.xref_missing"]

docs/installation.md

@@ -6,6 +6,16 @@ You can install `jupyterlite-sphinx` with `pip`:
 pip install jupyterlite-sphinx
 ```
 
+`jupyterlite-sphinx` is also available on `conda-forge`. You can install it with `conda` or `mamba`:
+
+```bash
+# with conda
+conda install -c conda-forge jupyterlite-sphinx
+
+# with mamba
+mamba install -c conda-forge jupyterlite-sphinx
+```
+
 then you need to add the `jupyterlite-sphinx` extension to your `conf.py` file of your sphinx docs:
 
 ```python

pyproject.toml

@@ -21,6 +21,10 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
+dev = [
+    "hatch",
+]
+
 docs = [
     "myst_parser",
     "pydata-sphinx-theme",
@@ -33,3 +37,9 @@ path = "jupyterlite_sphinx/__init__.py"
 include = [
     "/jupyterlite_sphinx",
 ]
+
+[tool.hatch.envs.docs]
+features = ["docs"]
+[tool.hatch.envs.docs.scripts]
+build = "sphinx-build -W -b html docs docs/build/html"
+serve = "python -m http.server --directory docs/build/html"