/
pydocmd.yml
86 lines (84 loc) · 3.5 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
# 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++
- vortexasdk.endpoints.timeseries_result++
- 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++
- endpoints/eia_forecasts.md:
- vortexasdk.endpoints.eia_forecasts++
- vortexasdk.endpoints.eia_forecasts_result++
pages:
- Home: index.md << README.md
- Endpoints:
About Endpoints: endpoints/about-endpoints.md << docs/endpoints/about-endpoints.md
Cargo Movements: endpoints/cargo_movements.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
- Entities:
Cargo Movement: entities/cargo_movement.md
Corporation: entities/corporation.md
Geography: entities/geography.md
Product: entities/product.md
Vessel: entities/vessel.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: