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

add docs #51

Merged
merged 14 commits into from
Sep 22, 2021
Merged

add docs #51

merged 14 commits into from
Sep 22, 2021

Conversation

casperdcl
Copy link
Collaborator

@casperdcl casperdcl commented Sep 10, 2021

  • gh-pages: https://docs.iterative.ai/shtab/
    • put all of README into organised website
    • auto-generate API reference & add source links
  • fix README logo
  • update repo metadata & description
  • auto-deploy docs on release

caveats

  • "Edit" button gives 404 on generated pages
  • follow-up: replace README sections with links to website

@casperdcl casperdcl added documentation Markdown files testing Unit tests & debugging labels Sep 10, 2021
@casperdcl casperdcl self-assigned this Sep 10, 2021
@casperdcl casperdcl force-pushed the docs branch 2 times, most recently from 939acf0 to 0dea2d7 Compare September 10, 2021 14:01
@codecov-commenter
Copy link

codecov-commenter commented Sep 10, 2021

Codecov Report

Merging #51 (93d9365) into master (5d17c85) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #51   +/-   ##
=======================================
  Coverage   88.80%   88.80%           
=======================================
  Files           3        3           
  Lines         250      250           
=======================================
  Hits          222      222           
  Misses         28       28           
Impacted Files Coverage Δ
shtab/__init__.py 92.19% <ø> (ø)

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 5d17c85...93d9365. Read the comment docs.

@casperdcl casperdcl marked this pull request as ready for review September 10, 2021 15:05
@casperdcl casperdcl force-pushed the docs branch 9 times, most recently from a9f3446 to ea0744f Compare September 10, 2021 21:32
@casperdcl casperdcl force-pushed the docs branch 2 times, most recently from 5db0d05 to 957ea71 Compare September 11, 2021 21:07
@casperdcl casperdcl merged commit af6aefb into master Sep 22, 2021
@casperdcl casperdcl deleted the docs branch September 22, 2021 21:56
@jorgeorpinel
Copy link

@casperdcl sorry for the delay. Did you want the docs team to review this one for clarity/ copy edits/ etc?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Markdown files testing Unit tests & debugging
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants