Merge pull request #77 from syasini/develop

Develop
syasini · Sep 16, 2020 · 3bde3b0 · 3bde3b0
2 parents 9b2fdbb + daa7357
commit 3bde3b0
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 339 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,8 @@
 _A python package for painting the sky_ 
 
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/syasini/AstroPaint/master?filepath=tutorial.ipynb)
+[![Documentation Status](https://readthedocs.org/projects/astropaint/badge/?version=master)](https://astropaint.readthedocs.io/en/master/?badge=master)
+
 
 You can install **AstroPaint** by running the following in the command line:
 
@@ -64,7 +66,7 @@ profile of the astrophysical effect. The package also provides a suite of tools
 
 # Package Structure 
 
-While there is no external documentation for the code yet, you can use [this
+See our [documentation](https://astropaint.readthedocs.io/) and [this
  chart](https://www.mindmeister.com/1417665103/astropaint-astropaint-py?fullscreen=1)
  to understand the package structure and see what methods are available so
   far. 

diff --git a/README.rst b/README.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -81,7 +81,7 @@ application extends to halos of arbitrary size or even point sources.
 Package Structure
 =================
 
-While there is no external documentation for the code yet, you can use `this chart <https://www.mindmeister.com/1417665103/astropaint-astropaint-py?fullscreen=1>`_
+See our `documentation <https://astropaint.readthedocs.io/>`_ and `this chart <https://www.mindmeister.com/1417665103/astropaint-astropaint-py?fullscreen=1>`_
 to understand the package structure and see what methods are available so far.
 
 Examples