/
pydocmd.yml
158 lines (157 loc) · 7.95 KB
/
pydocmd.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# This file is used by pydocmd to generate markdown files from python modules
site_name: VortexaSDK
docs_dir: docs/
repo_url: https://github.com/vortechsa/python-sdk
# Generate the individual markdown files from specified python modules
generate:
- endpoints/cargo_movements.md:
- vortexasdk.endpoints.cargo_movements++
- vortexasdk.endpoints.cargo_movements_result++
- endpoints/vessel_movements.md:
- vortexasdk.endpoints.vessel_movements++
- vortexasdk.endpoints.vessel_movements_result++
- endpoints/cargo_timeseries.md:
- vortexasdk.endpoints.cargo_timeseries++
- endpoints/corporations.md:
- vortexasdk.endpoints.corporations++
- vortexasdk.endpoints.corporations_result++
- endpoints/vessels.md:
- vortexasdk.endpoints.vessels++
- vortexasdk.endpoints.vessels_result++
- endpoints/geographies.md:
- vortexasdk.endpoints.geographies++
- vortexasdk.endpoints.geographies_result++
- endpoints/products.md:
- vortexasdk.endpoints.products++
- vortexasdk.endpoints.products_result++
- endpoints/attributes.md:
- vortexasdk.endpoints.attributes++
- vortexasdk.endpoints.attributes_result++
- entities/product.md:
- vortexasdk.api.product++
- entities/geography.md:
- vortexasdk.api.geography++
- entities/corporation.md:
- vortexasdk.api.corporation++
- entities/vessel.md:
- vortexasdk.api.vessel++
- entities/cargo_movement.md:
- vortexasdk.api.cargo_movement++
- entities/vessel_movement.md:
- vortexasdk.api.vessel_movement++
- entities/vessel_availability.md:
- vortexasdk.api.vessel_availability++
- entities/timeseries_item.md:
- vortexasdk.api.timeseries_item++
- entities/breakdown_item.md:
- vortexasdk.api.breakdown_item++
- entities/voyages.md:
- vortexasdk.api.voyages++
- endpoints/origin_breakdown.md:
- vortexasdk.endpoints.origin_breakdown++
- endpoints/destination_breakdown.md:
- vortexasdk.endpoints.destination_breakdown++
- endpoints/tonne_miles_breakdown.md:
- vortexasdk.endpoints.tonne_miles_breakdown++
- endpoints/vessel_availability_search.md:
- vortexasdk.endpoints.vessel_availability_search++
- endpoints/vessel_availability_timeseries.md:
- vortexasdk.endpoints.vessel_availability_timeseries++
- endpoints/vessel_availability_breakdown.md:
- vortexasdk.endpoints.vessel_availability_breakdown++
- endpoints/fleet_utilisation_speed_breakdown.md:
- vortexasdk.endpoints.fleet_utilisation_speed_breakdown++
- endpoints/fleet_utilisation_timeseries.md:
- vortexasdk.endpoints.fleet_utilisation_timeseries++
- endpoints/fleet_utilisation_avg_distance_timeseries.md:
- vortexasdk.endpoints.fleet_utilisation_avg_distance_timeseries++
- endpoints/fleet_utilisation_quantity_timeseries.md:
- vortexasdk.endpoints.fleet_utilisation_quantity_timeseries++
- endpoints/fleet_utilisation_capacity_timeseries.md:
- vortexasdk.endpoints.fleet_utilisation_capacity_timeseries++
- endpoints/fleet_utilisation_origin_breakdown.md:
- vortexasdk.endpoints.fleet_utilisation_origin_breakdown++
- endpoints/fleet_utilisation_destination_breakdown.md:
- vortexasdk.endpoints.fleet_utilisation_destination_breakdown++
- endpoints/eia_forecasts.md:
- vortexasdk.endpoints.eia_forecasts++
- vortexasdk.endpoints.eia_forecasts_result++
- endpoints/asset_tanks.md:
- vortexasdk.endpoints.asset_tanks++
- vortexasdk.endpoints.asset_tanks_result++
- endpoints/storage_terminals.md:
- vortexasdk.endpoints.storage_terminals++
- vortexasdk.endpoints.storage_terminals_result++
- endpoints/onshore_inventories_search.md: vortexasdk.endpoints.onshore_inventories_search++
- endpoints/onshore_inventories_timeseries.md: vortexasdk.endpoints.onshore_inventories_timeseries++
- endpoints/freight_pricing_search.md: vortexasdk.endpoints.freight_pricing_search++
- endpoints/freight_pricing_timeseries.md: vortexasdk.endpoints.freight_pricing_timeseries++
- endpoints/voyages_search_enriched.md: vortexasdk.endpoints.voyages_search_enriched++
- endpoints/voyages_timeseries.md: vortexasdk.endpoints.voyages_timeseries++
- endpoints/voyages_top_hits.md: vortexasdk.endpoints.voyages_top_hits++
- endpoints/voyages_congestion_breakdown.md: vortexasdk.endpoints.voyages_congestion_breakdown++
pages:
- Home: index.md << README.md
- Endpoints:
About Endpoints: endpoints/about-endpoints.md << docs/endpoints/about-endpoints.md
Cargo Movements: endpoints/cargo_movements.md
Origin Breakdown: endpoints/origin_breakdown.md
Destination Breakdown: endpoints/destination_breakdown.md
Cargo Time Series: endpoints/cargo_timeseries.md
Vessel Movements: endpoints/vessel_movements.md
Attributes: endpoints/attributes.md
Corporations: endpoints/corporations.md
Geographies: endpoints/geographies.md
Products: endpoints/products.md
Vessels: endpoints/vessels.md
EIA Forecasts: endpoints/eia_forecasts.md
Tonne-miles Breakdown: endpoints/tonne_miles_breakdown.md
Vessel Availability: endpoints/vessel_availability_search.md
Vessel Availability Time Series: endpoints/vessel_availability_timeseries.md
Vessel Availability Breakdown: endpoints/vessel_availability_breakdown.md
Fleet Utilisation Speed Breakdown: endpoints/fleet_utilisation_speed_breakdown.md
Fleet Utilisation Time Series: endpoints/fleet_utilisation_timeseries.md
Fleet Utilisation Avg Distance Time Series: endpoints/fleet_utilisation_avg_distance_timeseries.md
Fleet Utilisation Quantity Time Series: endpoints/fleet_utilisation_quantity_timeseries.md
Fleet Utilisation Capacity Time Series: endpoints/fleet_utilisation_capacity_timeseries.md
Fleet Utilisation Origin Breakdown: endpoints/fleet_utilisation_origin_breakdown.md
Fleet Utilisation Destination Breakdown: endpoints/fleet_utilisation_destination_breakdown.md
Asset Tanks: endpoints/asset_tanks.md
Storage Terminals: endpoints/storage_terminals.md
Crude Onshore Inventories Search: endpoints/onshore_inventories_search.md
Crude Onshore Inventories Time Series: endpoints/onshore_inventories_timeseries.md
Freight Pricing Search: endpoints/freight_pricing_search.md
Freight Pricing Time Series: endpoints/freight_pricing_timeseries.md
Voyages Search Enriched: endpoints/voyages_search_enriched.md
Voyages Time Series: endpoints/voyages_timeseries.md
Voyages Top Hits: endpoints/voyages_top_hits.md
Voyages Congestion Breakdown: endpoints/voyages_congestion_breakdown.md
- Entities:
Breakdown Item: entities/breakdown_result.md
Cargo Movement: entities/cargo_movement.md
Corporation: entities/corporation.md
Geography: entities/geography.md
Product: entities/product.md
Time Series Item: entities/timeseries_result.md
Vessel: entities/vessel.md
Vessel Availability: entities/availability.md
Vessel Movement: entities/vessel_movement.md
- Config: config.md << docs/config/config.md
- FAQ:
Setup: faq_setup.md << docs/faq_setup.md
General: faq.md << docs/faq.md
- Examples:
0 Simple Load Cargo Movements: examples/0_sample_load_cargo_movements.md
1 China VLCC Discharges: examples/1_china.md
2 Laden Vessel Movements: examples/2_all_vessel_movements.md
3 Crude movements from Saudi Arabia to India: examples/3_crude_from_saudi_arabia_to_india.md
4 Ballast Movements: examples/4_ballast_movements.md
5 Chinese Daily Crude Imports: examples/5_chinese_daily_imports.md
6 Floating Storage Medium Sour Crude: examples/6_medium_sour_floating_storage.md
7 Ingest Custom Excel Charterers: examples/7_custom_excel_charterer_ingestion.md
Jupyter Notebooks: examples/jupyter_notebooks.md
theme:
name: readthedocs
collapse_navigation: true
search_index_only: false
custom_dir: custom_theme/ # https://github.com/mkdocs/mkdocs/issues/1671#issuecomment-543252346: