Move unit_registry into __init__ so it appears in docs

openscm · Dec 5, 2023 · cdba618 · cdba618
1 parent d1b8546
commit cdba618
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 13 deletions.
diff --git a/docs/source/api/openscm_units.rst b/docs/source/api/openscm_units.rst
@@ -11,6 +11,12 @@ API Reference
 
   openscm_units.data
 
+unit\_registry
+==============
+
+.. autodata:: unit_registry
+
+
 ScmUnitRegistry
 ===============
 

diff --git a/src/openscm_units/__init__.py b/src/openscm_units/__init__.py
@@ -3,11 +3,23 @@
 """
 import importlib.metadata
 
-from ._unit_registry import ScmUnitRegistry, unit_registry
+from ._unit_registry import ScmUnitRegistry
 
 __version__ = importlib.metadata.version("openscm_units")
 
 __all__ = [
     "ScmUnitRegistry",
     "unit_registry",
 ]
+
+
+unit_registry = ScmUnitRegistry()
+"""
+Standard unit registry
+
+The unit registry contains all of the recognised units. Be careful, if you
+edit this registry in one place then it will also be edited in any other
+places that use :mod:`openscm_units`. If you want multiple, separate registries,
+create multiple instances of :class:`ScmUnitRegistry`.
+"""
+unit_registry.add_standards()
diff --git a/src/openscm_units/_unit_registry.py b/src/openscm_units/_unit_registry.py
@@ -514,15 +514,3 @@ def split_gas_mixture(
             ret.append(quantity / mixture_unit * fraction_pct / 100 * constituent_unit)
 
         return ret
-
-
-unit_registry = ScmUnitRegistry()
-"""
-Standard unit registry
-
-The unit registry contains all of the recognised units. Be careful, if you
-edit this registry in one place then it will also be edited in any other
-places that use ``openscm_units``. If you want multiple, separate registries,
-create multiple instances of ``ScmUnitRegistry``.
-"""
-unit_registry.add_standards()