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 mkdocs documentation #33

Merged
merged 20 commits into from
Feb 6, 2022
Merged

Add mkdocs documentation #33

merged 20 commits into from
Feb 6, 2022

Conversation

rszamszur
Copy link
Member

@rszamszur rszamszur commented Feb 5, 2022

Resolves: #9

TODO:

  • Init mkdocs documentation
  • Add base documentation contents
  • Add usage documentation contents
  • Add deployment documentation contents
  • Add workflow for building and deploying doc to GH pages

Still to figureout:

@rszamszur rszamszur added the documentation Improvements or additions to documentation label Feb 5, 2022
@rszamszur rszamszur added this to the 0.8.0 milestone Feb 5, 2022
@rszamszur rszamszur self-assigned this Feb 5, 2022
@codecov-commenter
Copy link

codecov-commenter commented Feb 5, 2022

Codecov Report

Merging #33 (5b751e9) into master (fe2ca54) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #33   +/-   ##
=======================================
  Coverage   99.18%   99.18%           
=======================================
  Files          15       15           
  Lines         369      369           
=======================================
  Hits          366      366           
  Misses          3        3           

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 fe2ca54...5b751e9. Read the comment docs.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 6, 2022

@rszamszur rszamszur marked this pull request as ready for review February 6, 2022 19:49
@rszamszur rszamszur merged commit cd9321e into master Feb 6, 2022
@rszamszur rszamszur deleted the add_documentation branch February 6, 2022 19:49
@rszamszur rszamszur mentioned this pull request Feb 15, 2022
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation
2 participants