Skip to content

Commit

Permalink
Get around autosummary.import_cycle warning
Browse files Browse the repository at this point in the history
From RTD run using Sphinx 8.0.2:

WARNING: Summarised items should not include the current module. Replace 'uscrn.get_data' with 'get_data'. [autosummary.import_cycle]
WARNING: Summarised items should not include the current module. Replace 'uscrn.get_nrt_data' with 'get_nrt_data'. [autosummary.import_cycle]
WARNING: Summarised items should not include the current module. Replace 'uscrn.to_xarray' with 'to_xarray'. [autosummary.import_cycle]
WARNING: Summarised items should not include the current module. Replace 'uscrn.read' with 'read'. [autosummary.import_cycle]
WARNING: Summarised items should not include the current module. Replace 'uscrn.read_daily' with 'read_daily'. [autosummary.import_cycle]
WARNING: Summarised items should not include the current module. Replace 'uscrn.read_daily_nrt' with 'read_daily_nrt'. [autosummary.import_cycle]
WARNING: Summarised items should not include the current module. Replace 'uscrn.read_hourly' with 'read_hourly'. [autosummary.import_cycle]
WARNING: Summarised items should not include the current module. Replace 'uscrn.read_hourly_nrt' with 'read_hourly_nrt'. [autosummary.import_cycle]
WARNING: Summarised items should not include the current module. Replace 'uscrn.read_monthly' with 'read_monthly'. [autosummary.import_cycle]
WARNING: Summarised items should not include the current module. Replace 'uscrn.read_subhourly' with 'read_subhourly'. [autosummary.import_cycle]
WARNING: Summarised items should not include the current module. Replace 'uscrn.load_meta' with 'load_meta'. [autosummary.import_cycle]

I want to have the fully qualified names show up in the docs,
so at least for now I don't want to make that suggested replacement

I also tried current module None, but that gave error like
"no module None.uscrn"
  • Loading branch information
zmoon committed Aug 18, 2024
1 parent 8f0ea49 commit aba9ba8
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions uscrn/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
* Info: https://www.ncei.noaa.gov/access/crn/qcdatasets.html
* Data: https://www.ncei.noaa.gov/pub/data/uscrn/products/
.. currentmodule:: ~
Get data
--------
Expand Down

0 comments on commit aba9ba8

Please sign in to comment.