diff --git a/docs/index.rst b/docs/index.rst index b9fb718..d67a998 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,7 +10,7 @@ From the official `CZML Guide `_ and leverages a lot of it's capabilities to achieve it's goal: making the process of writing CZML files in Python easy. +``czml3`` is built upon `pydantic `_ and leverages a lot of it's capabilities to achieve it's goal: making the process of writing CZML files in Python easy. Type Checking ------------- @@ -18,12 +18,12 @@ Forbid Unrecognised Properties Unrecognised inputs to classes are forbidden, which ensures the CZML document contains only recognised and valid fields. -If a valid property of a czml3 class is missing then please `open an issue `_. +If a valid property of a ``czml3`` class is missing then please `open an issue `_. Minimal CZML File Creation -------------------------- -czml3 will remove all fields that are not set (i.e. ``None``), which ensures that the CZML file is as small as possible. +``czml3`` will remove all fields that are not set (i.e. ``None``), which ensures that the CZML file is as small as possible. Performant JSON Serialisation -------------------------- diff --git a/docs/user/installation.rst b/docs/user/installation.rst index 950496a..52729ad 100644 --- a/docs/user/installation.rst +++ b/docs/user/installation.rst @@ -1,10 +1,10 @@ Installation ============ -You can install czml3 using pip:: +You can install ``czml3`` using ``pip``:: pip install czml3 -or conda:: +or ``conda``:: conda install czml3 --channel conda-forge \ No newline at end of file