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

Another round of updates to the documentation #153

Merged
merged 1 commit into from
Sep 15, 2020

Conversation

amotl
Copy link
Member

@amotl amotl commented Sep 15, 2020

Dear Benjamin,

these updates adjust the documentation once more. I hope you like them.

Cheers,
Andreas.

@amotl amotl requested a review from gutzbenj September 15, 2020 04:17
@codecov
Copy link

codecov bot commented Sep 15, 2020

Codecov Report

Merging #153 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #153   +/-   ##
=======================================
  Coverage   91.85%   91.85%           
=======================================
  Files          28       28           
  Lines        1436     1436           
  Branches      103      103           
=======================================
  Hits         1319     1319           
  Misses         88       88           
  Partials       29       29           
Flag Coverage Δ
#unittests 91.85% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
wetterdienst/additionals/functions.py 100.00% <ø> (ø)
wetterdienst/additionals/geo_location.py 100.00% <ø> (ø)
wetterdienst/api.py 80.19% <ø> (ø)
wetterdienst/data_collection.py 78.43% <ø> (ø)
wetterdienst/data_models/coordinates.py 90.90% <ø> (ø)
wetterdienst/data_storing.py 66.66% <ø> (ø)
wetterdienst/download/download.py 75.86% <ø> (ø)
wetterdienst/download/download_services.py 100.00% <ø> (ø)
...terdienst/enumerations/column_names_enumeration.py 100.00% <ø> (ø)
wetterdienst/parse_metadata.py 81.81% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fea8648...75ace74. Read the comment docs.

Copy link
Member

@gutzbenj gutzbenj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm glad you put so much work in it! I guess especially the autodoc integration will lift this to another level! Thanks!

@amotl amotl merged commit 7c41359 into earthobservations:master Sep 15, 2020
@gutzbenj
Copy link
Member

It seems the rendering of the modules is not working atm.

@amotl
Copy link
Member Author

amotl commented Sep 15, 2020

True. I really was looking forward to autodoc. It works on my machine, though.

You might want to verify it first on your machine and then investigate what might go wrong on RTD?

I just tried to tweak a few things within .readthedocs.yml and docs/requirements.txt in order to ensure the wetterdienst package gets actually installed, but apparently still failed on that yet.

@gutzbenj
Copy link
Member

Sure I'll have a look later! By the way the Material Theme does not offer a download of the PDF version. Do you know if there's a way to get that working?

This was referenced Sep 15, 2020
@amotl amotl deleted the more-docs branch September 23, 2020 00:31
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.

None yet

2 participants