Fix issue with Font Awesome icons not rendering correctly on readthedocs.io

Author: JWCook

docs/_static/colors.sass docs/_static/colors.cssdocs/_static/colors.sass renamed to docs/_static/colors.css

@@ -3,4 +3,5 @@
 .md-secondary {color: var(--color-brand-content)}
 
 /* Color for Font Awesome icons */
-span.fa {color: var(--color-brand-primary)}
+span.fa {color: var(--color-brand-primary)}
+span.fas {color: var(--color-brand-primary)}

docs/conf.py

@@ -140,9 +140,10 @@
 html_js_files = ['collapsible_container.js']
 html_css_files = [
     'collapsible_container.css',
-    'colors.sass',
+    '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'

pyinaturalist/models/identification.py

@@ -14,7 +14,7 @@
 
 @define_model
 class Identification(BaseModel):
-    """:fa:`fingerprint` 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>`_.
     """
 

pyinaturalist/models/life_list.py

@@ -14,7 +14,7 @@
 
 @define_model
 class LifeListTaxon(TaxonCount):
-    """:fa:`dove` :fa:`list` A single :py:class:`.Taxon` in a user's :py:class:`.LifeList`"""
+    """:fa:`dove,style=fas` :fa:`list` A single :py:class:`.Taxon` in a user's :py:class:`.LifeList`"""
 
     descendant_obs_count: int = field(default=0, doc='Number of observations of taxon children')
     direct_obs_count: int = field(
@@ -42,7 +42,7 @@ def __str__(self) -> str:
 
 @define_model_collection
 class LifeList(TaxonCounts):
-    """:fa:`dove` :fa:`list` A user's life list, based on the schema of ``GET /observations/taxonomy``"""
+    """:fa:`dove,style=fas` :fa:`list` A user's life list, based on the schema of ``GET /observations/taxonomy``"""
 
     count_without_taxon: int = field(default=0)
     data: List[LifeListTaxon] = field(factory=list, converter=LifeListTaxon.from_json_list)  # type: ignore

pyinaturalist/models/place.py

@@ -20,7 +20,7 @@ def convert_optional_lat_long(obj: Union[Dict, List, None, str]):
 
 @define_model
 class Place(BaseModel):
-    """:fa:`map-marker-alt` A curated or community-contributed place. Handles data from the following endpoints:
+    """:fa:`map-marker-alt,style=fas` A curated or community-contributed place. Handles data from the following endpoints:
 
     * `GET /places/{id} <https://api.inaturalist.org/v1/docs/#!/Places/get_places_id>`_
     * `GET /places/nearby <https://api.inaturalist.org/v1/docs/#!/Places/get_places_nearby>`_

pyinaturalist/models/taxon.py

@@ -90,7 +90,7 @@ def __str__(self) -> str:
 
 @define_model
 class Taxon(BaseModel):
-    """:fa:`dove` An iNaturalist taxon, based on the schema of
+    """:fa:`dove,style=fas` An iNaturalist taxon, based on the schema of
     `GET /taxa <https://api.inaturalist.org/v1/docs/#!/Taxa/get_taxa>`_.
 
     Can be constructed from either a full or partial JSON record. Examples of partial records
@@ -266,7 +266,7 @@ def __str__(self) -> str:
 
 @define_model
 class TaxonCount(Taxon):
-    """:fa:`dove` :fa:`list` A :py:class:`.Taxon` with an associated count, used in a :py:class:`.TaxonCounts`
+    """:fa:`dove,style=fas` :fa:`list` A :py:class:`.Taxon` with an associated count, used in a :py:class:`.TaxonCounts`
     collection
     """
 
@@ -296,7 +296,7 @@ def __str__(self) -> str:
 
 @define_model_collection
 class TaxonCounts(BaseModelCollection):
-    """:fa:`dove` :fa:`list` A collection of taxa with an associated counts. Used with
+    """:fa:`dove,style=fas` :fa:`list` A collection of taxa with an associated counts. Used with
     `GET /observations/species_counts <https://api.inaturalist.org/v1/docs/#!/Observations/get_observations_species_counts>`_.
     as well as :py:class:`.LifeList`.
     """