add readme to docs (#7)

lanl · Jan 21, 2025 · 7825bb3 · 7825bb3
1 parent b6cceed
commit 7825bb3
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -10,3 +10,4 @@ wheels/
 .venv
 
 demos/emcee.ipynb
+docs/
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 A probabilistic programming language for python built on `numpy`.
 
 ## Installation
-To install from PyPI:
+To install from PyPI (recommended):
 
 **pip**
 ```
@@ -197,4 +197,5 @@ but you cannot install `jupyter` also. If you must use `jupyter`, use python
 
 [ci-status-img]: https://img.shields.io/github/actions/workflow/status/lanl/arianna-ppl/CI.yml?style=flat-square&label=CI
 [pypi-version]: https://img.shields.io/pypi/v/arianna-ppl?style=flat-square&label=PyPI
-[pypi-downloads]: https://img.shields.io/pypi/dm/arianna-ppl?style=flat-square&label=Downloads
+[pypi-downloads]: https://img.shields.io/pypi/dm/arianna-ppl?style=flat-square&label=Downloads&color=blue
+
diff --git a/src/arianna/__init__.py b/src/arianna/__init__.py
@@ -0,0 +1,4 @@
+"""
+.. include:: ../../README.md
+   :start-line: 1
+"""
Original file line number	Diff line number	Diff line change
Expand Up		@@ -10,3 +10,4 @@ wheels/
		.venv

		demos/emcee.ipynb
		docs/