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

Extend pages for API documentation #348

Merged
merged 12 commits into from
Mar 23, 2020
Merged

Conversation

danielhuppmann
Copy link
Member

@danielhuppmann danielhuppmann commented Mar 20, 2020

Please confirm that this PR has done the following:

  • Documentation Added
  • Description in RELEASE_NOTES.md Added

Description of PR

This PR fell into a few rabbit holes (after starting off as a minor clean-up prior to release of v0.5).

  • separate the API doc page into several subpages, add functions that weren't previously documented (general functions, variables utils, read_datapackage())
  • update all references in the tutorial notebooks and other docs pages (because of changes in the item above)
  • add numpydoc reference to "contributing" guidelines
  • set up intersphinx for pandas and numpy
  • harmonize formatting and use :code:-style less often to improve readability (make pages less busy)
  • switch to more-numpydoc-compatible docstrings
  • fix a bunch of "not-displayed-as-intended" issues

This branch is rendered on readthedocs.

@coveralls
Copy link

coveralls commented Mar 20, 2020

Coverage Status

Coverage decreased (-0.05%) to 85.797% when pulling 50b23fc on docs/clean-up_v0.5 into ce03f5a on master.

@gidden
Copy link
Member

gidden commented Mar 20, 2020

Reviewed online and looks great! Thanks a bunch @danielhuppmann

@danielhuppmann
Copy link
Member Author

merging myself because the PR only concerns documentation and built doc pages spot-checked by @gidden

@danielhuppmann danielhuppmann merged commit f5cba2a into master Mar 23, 2020
@danielhuppmann danielhuppmann deleted the docs/clean-up_v0.5 branch March 23, 2020 14:07
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.

4 participants