.. _gv-reference:

:fa:`mountain` Reference
========================

.. note::
    :class: margin, dropdown, toggle-shown

    Content marked with 🚧 indicates it's still under construction.


Consult our reference material for no fuss facts about ``geovista``.

.. grid:: 1 1 2 2
    :gutter: 2

    .. grid-item-card:: About
        :class-title: custom-title
        :class-body: custom-body
        :link: gv-about
        :link-type: ref
        :img-top: ../_static/images/icons/about.svg
        :class-img-top: dark-light
        :class-card: sd-rounded-3

        Package metadata.

    .. grid-item-card:: Environment Variables
        :class-title: custom-title
        :class-body: custom-body
        :link: gv-environment
        :link-type: ref
        :img-top: ../_static/images/icons/environment.svg
        :class-img-top: dark-light
        :class-card: sd-rounded-3

        Package controls.

    .. grid-item-card:: CLI
        :class-title: custom-title
        :class-body: custom-body
        :link: gv-cli
        :link-type: ref
        :img-top: ../_static/images/icons/cli.svg
        :class-img-top: dark-light
        :class-card: sd-rounded-3

        Command line interface.

    .. grid-item-card:: Key Bindings
        :class-title: custom-title
        :class-body: custom-body
        :link: gv-bindings
        :link-type: ref
        :img-top: ../_static/images/icons/bindings.svg
        :class-img-top: dark-light
        :class-card: sd-rounded-3

        GUI hot-keys.

    .. grid-item-card:: API Reference
        :class-title: custom-title
        :class-body: custom-body
        :link: gv-api
        :link-type: ref
        :img-top: ../_static/images/icons/api.svg
        :class-img-top: dark-light
        :class-card: sd-rounded-3

        Behaviour and state docstrings.

    .. grid-item-card:: Glossary
        :class-title: custom-title
        :class-body: custom-body
        :link: gv-glossary
        :link-type: ref
        :img-top: ../_static/images/icons/glossary.svg
        :class-img-top: dark-light
        :class-card: sd-rounded-3

        Jargon buster.

.. comment

    # TBD @bjlittle: add these cards back

    .. grid-item-card:: 🚧 Changelog
        :class-title: custom-title
        :class-body: custom-body
        :link: gv-changelog
        :link-type: ref
        :img-top: ../_static/images/icons/changelog.svg
        :class-img-top: dark-light
        :class-card: sd-rounded-3

        In depth release details.

    .. grid-item-card:: 🚧 What's New
        :class-title: custom-title
        :class-body: custom-body
        :link: gv-whatsnew
        :link-type: ref
        :img-top: ../_static/images/icons/whatsnew.svg
        :class-img-top: dark-light
        :class-card: sd-rounded-3

        Release highlights.



.. toctree::
    :maxdepth: 1
    :hidden:

    about
    environment
    cli/index
    bindings
    generated/api/geovista/index
    glossary

.. comment

    # TBD @bjlittle: add these sections back to the toc

    changelog
    whatsnew