mkdocs.yml

# This file is used by mkdocs to generate a static website from markdown files.
# The majority of this file is generated by running $ rm mkdocs.yml && pydocmd serve,
# However, we've had to manually specified this file here in order to add the google analytics tracking
google_analytics: ["UA-153895438-1", "vortechsa.github.io"]
docs_dir: _build/pydocmd
pages:
  - Home: index.md
  - Endpoints:
      About Endpoints: endpoints/about-endpoints.md
      Attributes: endpoints/attributes.md
      Canal Transit: endpoints/canal_transit.md
      Canal Transit Timeseries: endpoints/canal_transit_timeseries.md
      Cargo Movements: endpoints/cargo_movements.md
      Movement Status Breakdown: endpoints/movement_status_breakdown.md
      Product Breakdown: endpoints/product_breakdown.md
      Parent Product Breakdown: endpoints/parent_product_breakdown.md
      Vessel Class Breakdown: endpoints/vessel_class_breakdown.md
      Origin Breakdown: endpoints/origin_breakdown.md
      Destination Breakdown: endpoints/destination_breakdown.md
      Cargo Time Series: endpoints/cargo_timeseries.md
      Corporations: endpoints/corporations.md
      EIA Forecasts: endpoints/eia_forecasts.md
      Geographies: endpoints/geographies.md
      Products: endpoints/products.md
      Vessels: endpoints/vessels.md
      Fixtures: endpoints/fixtures.md
      Vessel Availability:
        Search: endpoints/vessel_availability_search.md
        Time Series: endpoints/vessel_availability_timeseries.md
        Breakdown: endpoints/vessel_availability_breakdown.md
      Crude Onshore Inventories:
        Search: endpoints/onshore_inventories_search.md
        Time Series: endpoints/onshore_inventories_timeseries.md
        Reference Data:
          Asset Tanks: endpoints/asset_tanks.md
          Storage Terminals: endpoints/storage_terminals.md
      Freight Pricing:
        Search: endpoints/freight_pricing_search.md
        Time Series: endpoints/freight_pricing_timeseries.md
      Voyages:
        Search Enriched: endpoints/voyages_search_enriched.md
        Time Series: endpoints/voyages_timeseries.md
        Time Series V2: endpoints/voyages_timeseries_v2.md
        Top Hits: endpoints/voyages_top_hits.md
        Geography Breakdown: endpoints/voyages_geography_breakdown.md
        Vessel Class Breakdown: endpoints/voyages_vessel_class_breakdown.md
        Product Breakdown: endpoints/voyages_product_breakdown.md
        Routes Breakdown: endpoints/voyages_routes_breakdown.md
        Congestion Breakdown: endpoints/voyages_congestion_breakdown.md
      Signals:
        Vessel Summary: endpoints/vessel_summary.md
        Vessel Positions: endpoints/vessel_positions.md
  - Entities:
      Canal Transit: entities/canal_transit.md
      Cargo Movement: entities/cargo_movement.md
      Corporation: entities/corporation.md
      Geography: entities/geography.md
      Product: entities/product.md
      Vessel: entities/vessel.md
      Voyages: entities/voyages.md
      Vessel Availability: entities/vessel_availability.md
      Time Series Item: entities/timeseries_item.md
      Breakdown Item: entities/breakdown_item.md
      Signals: entities/signals.md
  - Config: config.md
  - FAQ:
      General: faq.md
      Setup: faq_setup.md
  - Examples:
      0 Simple Load Cargo Movements: examples/0_sample_load_cargo_movements.md
      1 China VLCC Discharges: examples/1_china.md
      Jupyter Notebooks: examples/jupyter_notebooks.md
repo_url: https://github.com/vortechsa/python-sdk
site_dir: _build/site
site_name: VortexaSDK
theme:
  collapse_navigation: true
  custom_dir: custom_theme/
  name: readthedocs
  search_index_only: false