Merge pull request #207 from JWCook/fontawesome

Add sphinx-panels and fontawesome icons

CONTRIBUTING.md

@@ -80,13 +80,21 @@ Here are some general guidelines for submitting a pull request:
 - Submit the PR to be merged into the `main` branch.
 
 ### Releases
-For maintainers:
+Notes for maintainers on publishing new releases:
 
 Releases are based on git tags. GitHub Actions will build and deploy packages to PyPi on tagged commits
 on the `main` branch. Release steps:
-- Update the version in `pyinaturalist/__init__.py`
+- Update the version in both `pyproject.toml` and `pyinaturalist/__init__.py`
 - Update the release notes in `HISTORY.md`
 - Merge changes into the `main` branch
-- Push a new tag, e.g.: `git tag v0.1 && git push origin --tags`
+- Push a new tag, e.g.: `git tag v0.1.0 && git push upstream --tags`
 - This will trigger a deployment. Verify that this completes successfully and that the new version
-  can be installed from pypi with `pip install`
+  can be installed from PyPI with `pip install pyinaturalist`.
+- Verify that the docs are built and published to [Read The Docs](https://pyinaturalist.readthedocs.io).
+- A PR for a new Conda release will be created by a bot on the [pyinaturalist-feedstock](https://github.com/conda-forge/pyinaturalist-feedstock/)
+  repo. It may take a couple hours after PyPI deployment for this to happen. Typically this will be
+  auto-merged and built without any manual action required. Just verify that this completes successfully
+  and that the new version can be installed from conda-forge with `conda install -c conda-forge pyinaturalist`.
+  - If new depedencies have been added, then those must also be added to the [conda recipe](https://github.com/conda-forge/pyinaturalist-feedstock/blob/master/recipe/meta.yaml).
+- Update and build the Docker image for [pyinaturalist-notebook](https://github.com/JWCook/pyinaturalist-notebook).
+  - TODO: This should be fully automated, and triggered after the Conda build rather than the PyPI build.

README.md

@@ -6,6 +6,7 @@
 [![Coverage Status](https://coveralls.io/repos/github/niconoe/pyinaturalist/badge.svg?branch=main)](https://coveralls.io/github/niconoe/pyinaturalist?branch=main)
 
 [![PyPI](https://img.shields.io/pypi/v/pyinaturalist?color=blue)](https://pypi.org/project/pyinaturalist)
+[![Conda](https://img.shields.io/conda/vn/conda-forge/pyinaturalist?color=blue)](https://anaconda.org/conda-forge/pyinaturalist)
 [![PyPI - Python Versions](https://img.shields.io/pypi/pyversions/pyinaturalist)](https://pypi.org/project/pyinaturalist)
 [![PyPI - Format](https://img.shields.io/pypi/format/pyinaturalist?color=blue)](https://pypi.org/project/pyinaturalist)
 

docs/_static/colors.css

@@ -0,0 +1,7 @@
+/* Main theme colors */
+.md-primary {color: var(--color-brand-primary)}
+.md-secondary {color: var(--color-brand-content)}
+
+/* Color for Font Awesome icons */
+span.fa {color: var(--color-brand-primary)}
+span.fas {color: var(--color-brand-primary)}

docs/conf.py

@@ -48,7 +48,6 @@
 # General information about the project.
 copyright = '2021, Nicolas Noé, Jordan Cook'
 exclude_patterns = ['_build', f'{MODULE_DOCS_DIR}/pyinaturalist.rst']
-html_static_path = ['_static']
 master_doc = 'index'
 needs_sphinx = '4.0'
 project = 'pyinaturalist'
@@ -68,6 +67,7 @@
     'sphinx_automodapi.smart_resolver',
     'sphinx_copybutton',
     'sphinx_inline_tabs',
+    'sphinx_panels',
     'sphinxcontrib.apidoc',
     'myst_parser',
     'nbsphinx',
@@ -134,11 +134,17 @@
 numpydoc_show_class_members = False
 
 # HTML general settings
-html_logo = join('images', 'pyinaturalist_logo.png')
-# html_logo = join('images', 'python-logo-green.png')
-html_favicon = join('images', 'favicon.ico')
+html_static_path = ['_static']
+html_favicon = join('_static', 'favicon.ico')
+html_logo = join('_static', 'pyinaturalist_logo.png')
 html_js_files = ['collapsible_container.js']
-html_css_files = ['collapsible_container.css', 'table.css']
+html_css_files = [
+    'collapsible_container.css',
+    'colors.css',
+    'table.css',
+    'https://use.fontawesome.com/releases/v5.15.3/css/all.css',
+    'https://use.fontawesome.com/releases/v5.15.3/css/v4-shims.css',
+]
 html_show_sphinx = False
 pygments_style = 'friendly'
 pygments_dark_style = 'material'

pyinaturalist/models/comment.py

@@ -6,7 +6,7 @@
 
 @define_model
 class Comment(BaseModel):
-    """📝 An observation comment, based on the schema of comments
+    """:fa:`comment` An observation comment, based on the schema of comments
     from `GET /observations <https://api.inaturalist.org/v1/docs/#!/Observations/get_observations>`_.
     """
 

pyinaturalist/models/controlled_term.py

@@ -6,7 +6,7 @@
 
 @define_model
 class Annotation(BaseModel):
-    """📝 An annotation, meaning a **controlled term value** applied by a **user** to an **observation**.
+    """:fa:`tag` An annotation, meaning a **controlled term value** applied by a **user** to an **observation**.
     Based on the schema of annotations from
     `GET /observations <https://api.inaturalist.org/v1/docs/#!/Observations/get_observations>`_.
     """
@@ -45,7 +45,7 @@ def __str__(self) -> str:
 
 @define_model
 class ControlledTermValue(BaseModel):
-    """📋 A controlled term **value**, based on the schema of
+    """:fa:`tag` A controlled term **value**, based on the schema of
     `GET /controlled_terms <https://api.inaturalist.org/v1/docs/#!/Controlled_Terms/get_controlled_terms>`_.
     """
 
@@ -62,7 +62,7 @@ def __str__(self):
 
 @define_model
 class ControlledTerm(BaseModel):
-    """📋 A controlled term, based on the schema of
+    """:fa:`tag` A controlled term, based on the schema of
     `GET /controlled_terms <https://api.inaturalist.org/v1/docs/#!/Controlled_Terms/get_controlled_terms>`_.
     """
 

pyinaturalist/models/identification.py

@@ -14,7 +14,7 @@
 
 @define_model
 class Identification(BaseModel):
-    """🔎 An observation identification, based on the schema of
+    """:fa:`fingerprint,style=fas` An observation identification, based on the schema of
     `GET /identifications <https://api.inaturalist.org/v1/docs/#!/Identifications/get_identifications>`_.
     """