Adds API to docs, bumps version.

Niru Nahesh · Niru Nahesh · commit d0b37eefd6d6 · 2025-05-20T23:04:48.000-07:00
diff --git a/docs/api.md b/docs/api.md
@@ -0,0 +1,6 @@
+# API
+
+List of modules
+---------------
+
+
diff --git a/docs/api/chart_utils.md b/docs/api/chart_utils.md
@@ -0,0 +1,2 @@
+# chart_utils
+::: jetplot.chart_utils
diff --git a/docs/api/colors.md b/docs/api/colors.md
@@ -0,0 +1,2 @@
+# colors
+::: jetplot.colors
diff --git a/docs/api/images.md b/docs/api/images.md
@@ -0,0 +1,2 @@
+# images
+::: jetplot.images
diff --git a/docs/api/plots.md b/docs/api/plots.md
@@ -0,0 +1,2 @@
+# plots
+::: jetplot.plots
diff --git a/docs/api/signals.md b/docs/api/signals.md
@@ -0,0 +1,2 @@
+# signals
+::: jetplot.signals
diff --git a/docs/api/style.md b/docs/api/style.md
@@ -0,0 +1,2 @@
+# style
+::: jetplot.style
diff --git a/docs/api/timepiece.md b/docs/api/timepiece.md
@@ -0,0 +1,2 @@
+# timepiece
+::: jetplot.timepiece
diff --git a/docs/index.md b/docs/index.md
@@ -1,6 +1,33 @@
 # Jetplot
 
+
+[![Tests](https://github.com/nirum/jetplot/actions/workflows/ci.yml/badge.svg)](https://github.com/nirum/jetplot/actions/workflows/ci.yml)
+[![Typecheck](https://github.com/nirum/jetplot/actions/workflows/typecheck.yml/badge.svg)](https://github.com/nirum/jetplot/actions/workflows/typecheck.yml)
+
 Welcome to the **jetplot** documentation.
 
-`jetplot` is a collection of miscellaneous utilities for Matplotlib that simplify creating rich visualizations and color palettes.
+## About
+
+`jetplot` is a collection of miscellaneous utilities for Matplotlib that simplify creating rich visualizations and color palettes. It was created in 2015 by [Niru Maheswaranathan](https://niru.dev).
+
+
+## Installation
+
+```bash
+pip install jetplot
+```
+
+## Changelog
+
+| Version | Release Date | Description                                                                                                                                                                                                     |
+| ------: | :----------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| 0.6.0   | Jul 21 2024  | Migrated from setup.py to pyproject.toml.                                                                                                                                                     |
+| 0.5.3   | Aug 30 2022  | Stops jetplot from updating Matplotlib rcParams on import.                                                                                                                                                     |
+| 0.5.0   | Jul 15 2022  | Updates default color palettes, adds new Palette class, adds ridgeline plot.                                                                                                                                                     |
+| 0.4.0   | Oct 20 2021  | Name change! Package renamed to `jetplot`.                                                                                                                                                       |
+| 0.3.0   | Oct 13 2021  | Drops animation module and the `moviepy` dependency                                                                                                                                                             |
+| 0.0.0   | Jan 19 2015  | Initial commit                                                                                                                                                                                                  |
+
+## License
 
+MIT. See [`LICENSE.md`](./LICENSE.md)
diff --git a/justfile b/justfile
@@ -20,3 +20,13 @@ test:
 
 loop:
   find {src,tests} -name "*.py" | entr -c just test
+
+autoapi:
+  mkdir -p docs/api/
+  @for f in ./src/jetplot/*.py; do \
+    name="${f##*/}"; \
+    name="${name%.py}"; \
+    [[ "$name" == "__init__" ]] && continue; \
+    printf "# %s\n::: jetplot.%s\n" "${name}" "$name" > "docs/api/${name}.md"; \
+    echo "wrote ${name}.md"; \
+  done
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -5,6 +5,14 @@ repo_url: https://github.com/nirum/jetplot
 nav:
   - Home: index.md
   - Description: description.md
+  - API:
+    - Chart Utils: api/chart_utils.md
+    - Plots: api/plots.md
+    - Images: api/images.md
+    - Colors: api/colors.md
+    - Style: api/style.md
+    - Signals: api/signals.md
+    - Timepiece: api/timepiece.md
 
 theme:
   name: material
@@ -24,5 +32,3 @@ markdown_extensions:
   - admonition
   - pymdownx.highlight
   - pymdownx.superfences
-  - toc:
-      permalink: true
diff --git a/src/jetplot/__init__.py b/src/jetplot/__init__.py
@@ -1,6 +1,6 @@
 """Jetplot is a set of useful utility functions for scientific python."""
 
-__version__ = "0.6.4"
+__version__ = "0.6.5"
 
 from . import colors as c  # noqa: F401
 from .chart_utils import *

-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +# API
++
 +List of modules
 +---------------
++
++
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# chart_utils`
	`2`	`+::: jetplot.chart_utils`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# timepiece`
	`2`	`+::: jetplot.timepiece`