Merge pull request #9 from mgrover1/cleanup-docs

ENH: Cleanup the docs, including the README

README.rst

@@ -1,10 +1,10 @@
-.. image:: https://img.shields.io/github/workflow/status/openradar/cmweather/CI?logo=github&style=for-the-badge
-    :target: https://github.com/openradar/cmweather/actions
-    :alt: GitHub Workflow CI Status
+.. image:: https://github.com/openradar/cmweather/actions/workflows/ci.yaml/badge.svg
+    :target: https://github.com/openradar/cmweather/actions/workflows/ci.yaml
+    :alt: Continuous Integration Status
 
-.. image:: https://img.shields.io/github/workflow/status/openradar/cmweather/code-style?label=Code%20Style&style=for-the-badge
-    :target: https://github.com/openradar/cmweather/actions
-    :alt: GitHub Workflow Code Style Status
+.. image:: https://github.com/openradar/cmweather/actions/workflows/linting.yaml/badge.svg
+    :target: https://github.com/openradar/cmweather/actions/workflows/linting.yaml
+    :alt: Code Style Status
 
 .. image:: https://img.shields.io/codecov/c/github/openradar/cmweather.svg?style=for-the-badge
     :target: https://codecov.io/gh/openradar/cmweather

ci/environment-docs.yml

@@ -1,4 +1,4 @@
-name: cmweather-dev
+name: cmweather-docs
 channels:
   - conda-forge
 dependencies:

docs/source/conf.py

@@ -75,7 +75,7 @@
 # General information about the project.
 project = 'cmweather'
 current_year = datetime.datetime.now().year
-copyright = f'2020-{current_year}, Open Radar Community'
+copyright = f'2023-{current_year}, Open Radar Community'
 author = 'Open Radar Community'
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

docs/source/index.rst

@@ -1,4 +1,4 @@
-.. include:: ../../README.rst
+.. include:: ../../README.md
 
 Contents:
 =========

requirements.txt

@@ -1,5 +1,2 @@
-netcdf4
-xarray
-pooch
 numpy
 matplotlib