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

[Docs] Migrate to mkdocs #206

Merged
merged 14 commits into from
Sep 10, 2023
Merged

[Docs] Migrate to mkdocs #206

merged 14 commits into from
Sep 10, 2023

Conversation

kozistr
Copy link
Owner

@kozistr kozistr commented Sep 10, 2023

Problem (Why?)

related to #164

Solution (What/How?)

  • migrate from sphinx to mkdocs
  • fix docstring

Other changes (bug fixes, small refactors)

N/A

Notes

N/A

@kozistr kozistr added the documentation Improvements or additions to documentation label Sep 10, 2023
@kozistr kozistr self-assigned this Sep 10, 2023
@codecov
Copy link

codecov bot commented Sep 10, 2023

Codecov Report

Merging #206 (40e4c43) into main (d736c25) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main      #206   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           80        80           
  Lines         5732      5732           
=========================================
  Hits          5732      5732           
Files Changed Coverage Δ
pytorch_optimizer/loss/jaccard.py 100.00% <ø> (ø)
pytorch_optimizer/lr_scheduler/linear_warmup.py 100.00% <ø> (ø)
pytorch_optimizer/optimizer/srmm.py 100.00% <ø> (ø)

@kozistr kozistr merged commit 40882a9 into main Sep 10, 2023
3 checks passed
@kozistr kozistr deleted the docs/mkdocs branch September 10, 2023 13:29
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 size/XXL
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant