From b23ab91ca1313adf3d1d8d62f7121815f2b8de3e Mon Sep 17 00:00:00 2001 From: Arthur Lui Date: Tue, 21 Jan 2025 09:55:29 -0700 Subject: [PATCH] add readme to docs --- .gitignore | 1 + README.md | 5 +++-- src/arianna/__init__.py | 4 ++++ 3 files changed, 8 insertions(+), 2 deletions(-) create mode 100644 src/arianna/__init__.py diff --git a/.gitignore b/.gitignore index 0c1cc23..53dad13 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,4 @@ wheels/ .venv demos/emcee.ipynb +docs/ diff --git a/README.md b/README.md index d760005..9585e3f 100644 --- 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 new file mode 100644 index 0000000..c6dbae9 --- /dev/null +++ b/src/arianna/__init__.py @@ -0,0 +1,4 @@ +""" +.. include:: ../../README.md + :start-line: 1 +"""