Merge pull request #41 from jrmaddison/jrmaddison/docs

Documentation updates

docs/source/index.rst

@@ -33,6 +33,12 @@ The following Jupyter notebooks introduce bt_ocean.
 - `Steady state problems <examples/2_steady_state.ipynb>`__: Implicit
   differentiation for steady-state problems.
 
+Source
+------
+
+The source code is available from the
+`bt_ocean GitHub repository <https://github.com/jrmaddison/bt_ocean>`_.
+
 Indices
 -------
 

readme.rst

@@ -1,5 +1,14 @@
 bt_ocean
 ========
+|doi| |license|
+
+.. |doi| image:: https://github.com/jrmaddison/bt_ocean/actions/workflows/test-bt_ocean.yml/badge.svg?branch=main&event=push
+    :alt: doi
+    :target: https://github.com/jrmaddison/bt_ocean/actions/workflows/test-bt_ocean.yml
+
+.. |license| image:: https://img.shields.io/badge/license-MIT-green?style=flat-square
+   :alt: license
+   :target: https://github.com/jrmaddison/bt_ocean/blob/main/LICENSE
 
 bt_ocean is a differentiable finite difference solver for the barotropic
 vorticity equation on a beta-plane, for classic wind-forced barotropic ocean
@@ -18,3 +27,9 @@ Features
   gyre problems.
 - Uses the JAX library, providing GPU and autodiff support.
 - Integrates with the Keras library for online training of neural networks.
+
+Documentation
+-------------
+
+- `bt_ocean documentation <https://jrmaddison.github.io/bt_ocean>`_
+- `Module index <https://jrmaddison.github.io/bt_ocean/py-modindex.html>`_