Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set author in docs #40

Merged
merged 3 commits into from
Aug 18, 2024
Merged

Set author in docs #40

merged 3 commits into from
Aug 18, 2024

Conversation

zmoon
Copy link
Owner

@zmoon zmoon commented Aug 18, 2024

Otherwise it seems we now get "By Author name not set" on a line before the copyright line in the footer

Otherwise it seems we now get "By Author name not set"
on a line before the copyright line in the footer
Copy link

codecov bot commented Aug 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.53%. Comparing base (239833a) to head (507b70d).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #40   +/-   ##
=======================================
  Coverage   99.53%   99.53%           
=======================================
  Files           4        4           
  Lines         650      650           
=======================================
  Hits          647      647           
  Misses          3        3           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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"
@zmoon zmoon merged commit a763e8c into main Aug 18, 2024
6 checks passed
@zmoon zmoon deleted the author branch August 18, 2024 16:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant