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

Build API reference docs from docstrings using MKDocs #147

Merged
merged 5 commits into from
Aug 2, 2020
Merged

Build API reference docs from docstrings using MKDocs #147

merged 5 commits into from
Aug 2, 2020

Conversation

hugovk
Copy link
Collaborator

@hugovk hugovk commented Aug 2, 2020

For #139.

Changes proposed in this pull request:

  • First part for Add documentation on Read the Docs #139: build the docs from the docstrings (deploy to RTD or gh-pages follow)
  • Update most docstrings to follow the same format (still a few to do, can be updated later)
  • Also some v2 updates to lint.yml and test.yml

To test locally

pip install -U mkdocs mkdocs-material mkdocstrings
mkdocs build
# or
mkdocs serve

@hugovk hugovk added changelog: Added For new features documentation Improvements or additions to documentation labels Aug 2, 2020
@codecov-commenter
Copy link

codecov-commenter commented Aug 2, 2020

Codecov Report

Merging #147 into master will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #147   +/-   ##
=======================================
  Coverage   99.42%   99.42%           
=======================================
  Files           9        9           
  Lines         524      524           
=======================================
  Hits          521      521           
  Misses          3        3           
Flag Coverage Δ
#GHA_Ubuntu 99.42% <100.00%> (ø)
#GHA_Windows 99.42% <100.00%> (ø)
#GHA_macOS 99.42% <100.00%> (ø)

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

Impacted Files Coverage Δ
src/humanize/i18n.py 92.50% <ø> (ø)
src/humanize/number.py 100.00% <ø> (ø)
src/humanize/filesize.py 100.00% <100.00%> (ø)
src/humanize/time.py 100.00% <100.00%> (ø)

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 15ecb0a...52538c1. Read the comment docs.

@hugovk hugovk merged commit 5df1fc1 into jmoiron:master Aug 2, 2020
@hugovk hugovk deleted the update-docs branch August 2, 2020 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: Added For new features documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants