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: Updated documentation theme and README #61

Merged
merged 11 commits into from
May 31, 2022
Merged

docs: Updated documentation theme and README #61

merged 11 commits into from
May 31, 2022

Conversation

frgfm
Copy link
Owner

@frgfm frgfm commented May 31, 2022

This PR introduces the following modifications:

  • adds logo and favicon to the documentation
  • updates the documentation theme to furo
  • updates README badges
  • expanded unittest

@frgfm frgfm added topic: docs Improvements or additions to documentation type: improvement New feature or request ext: docs labels May 31, 2022
@frgfm frgfm added this to the 0.2.0 milestone May 31, 2022
@frgfm frgfm self-assigned this May 31, 2022
@codecov
Copy link

codecov bot commented May 31, 2022

Codecov Report

Merging #61 (be88085) into main (5029de0) will increase coverage by 6.25%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #61      +/-   ##
==========================================
+ Coverage   88.10%   94.35%   +6.25%     
==========================================
  Files          10       10              
  Lines         656      656              
==========================================
+ Hits          578      619      +41     
+ Misses         78       37      -41     
Impacted Files Coverage Δ
torchscan/crawler.py 84.32% <0.00%> (+2.23%) ⬆️
torchscan/modules/receptive.py 83.78% <0.00%> (+18.91%) ⬆️
torchscan/utils.py 100.00% <0.00%> (+25.00%) ⬆️

@frgfm frgfm merged commit 8dbe052 into main May 31, 2022
@frgfm frgfm deleted the doc-theme branch May 31, 2022 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ext: docs topic: docs Improvements or additions to documentation type: improvement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant