Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ From the official `CZML Guide <https://github.com/AnalyticalGraphicsInc/czml-wri

| CZML is a JSON format for describing a time-dynamic graphical scene, primarily for display in a web browser running Cesium. It describes lines, points, billboards, models, and other graphical primitives, and specifies how they change with time.

czml3 aims to make the process of writing CZML files in Python easy by:
``czml3`` aims to make the process of writing CZML files in Python easy by:

* Type checking properties
* Cooercion of data to their required format
Expand Down
2 changes: 1 addition & 1 deletion docs/user/contributing.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Contributing
============

This page details the features/properties that are missing from czml3. The lists are incomplete.
This page details the features/properties that are missing from ``czml3``. The lists are incomplete.

Missing CZML Properties
-----------------------
Expand Down
6 changes: 3 additions & 3 deletions docs/user/features.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Features
========

czml3 is built upon `pydantic <https://docs.pydantic.dev/latest/>`_ 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 <https://docs.pydantic.dev/latest/>`_ 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
-------------
Expand All @@ -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 <https://github.com/Stoops-ML/czml3/issues>`_.
If a valid property of a ``czml3`` class is missing then please `open an issue <https://github.com/Stoops-ML/czml3/issues>`_.

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
--------------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/user/installation.rst
Original file line number Diff line number Diff line change
@@ -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