Skip to content

Commit

Permalink
polish docs (#43)
Browse files Browse the repository at this point in the history
* updated docs

* changed Logo

* fixed sidebar

* fixed google search
  • Loading branch information
kbressem authored Mar 2, 2021
1 parent 10185ee commit cd9e581
Show file tree
Hide file tree
Showing 104 changed files with 3,605 additions and 11,940 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ sync:
nbdev_update_lib

docs_serve: docs
cd docs && bundle exec jekyll serve
cd docs && bundle exec jekyll serve

docs: $(SRC)
nbdev_build_docs
Expand Down
2 changes: 2 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
_site/
.netlify/
3 changes: 1 addition & 2 deletions docs/Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,4 @@ gem 'github-pages', group: :jekyll_plugins
gem "nokogiri", "< 1.10.9"
gem "jekyll", ">= 3.7"
gem "kramdown", ">= 2.3.0"
gem "jekyll-remote-theme"
gem "webrick", "1.7.0"
gem "jekyll-remote-theme"
28 changes: 13 additions & 15 deletions docs/Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
GEM
remote: https://rubygems.org/
specs:
activesupport (6.0.3.5)
activesupport (6.0.3.4)
concurrent-ruby (~> 1.0, >= 1.0.2)
i18n (>= 0.7, < 2)
minitest (~> 5.1)
Expand All @@ -16,7 +16,7 @@ GEM
colorator (1.1.0)
commonmarker (0.17.13)
ruby-enum (~> 0.5)
concurrent-ruby (1.1.8)
concurrent-ruby (1.1.7)
dnsruby (1.61.5)
simpleidn (~> 0.1)
em-websocket (0.5.2)
Expand All @@ -34,7 +34,7 @@ GEM
ffi (1.14.2)
forwardable-extended (2.6.0)
gemoji (3.0.1)
github-pages (211)
github-pages (209)
github-pages-health-check (= 1.16.1)
jekyll (= 3.9.0)
jekyll-avatar (= 0.7.0)
Expand All @@ -52,7 +52,7 @@ GEM
jekyll-relative-links (= 0.6.1)
jekyll-remote-theme (= 0.4.2)
jekyll-sass-converter (= 1.5.2)
jekyll-seo-tag (= 2.7.1)
jekyll-seo-tag (= 2.6.1)
jekyll-sitemap (= 1.4.0)
jekyll-swiss (= 1.0.0)
jekyll-theme-architect (= 0.1.1)
Expand All @@ -76,7 +76,7 @@ GEM
mercenary (~> 0.3)
minima (= 2.5.1)
nokogiri (>= 1.10.4, < 2.0)
rouge (= 3.26.0)
rouge (= 3.23.0)
terminal-table (~> 1.4)
github-pages-health-check (1.16.1)
addressable (~> 2.3)
Expand Down Expand Up @@ -143,8 +143,8 @@ GEM
rubyzip (>= 1.3.0, < 3.0)
jekyll-sass-converter (1.5.2)
sass (~> 3.4)
jekyll-seo-tag (2.7.1)
jekyll (>= 3.8, < 5.0)
jekyll-seo-tag (2.6.1)
jekyll (>= 3.3, < 5.0)
jekyll-sitemap (1.4.0)
jekyll (>= 3.7, < 5.0)
jekyll-swiss (1.0.0)
Expand Down Expand Up @@ -201,7 +201,7 @@ GEM
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.3)
listen (3.4.1)
listen (3.4.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.3.6)
Expand All @@ -224,10 +224,10 @@ GEM
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.4)
rouge (3.26.0)
ruby-enum (0.9.0)
rouge (3.23.0)
ruby-enum (0.8.0)
i18n
ruby2_keywords (0.0.4)
ruby2_keywords (0.0.2)
rubyzip (2.3.0)
safe_yaml (1.0.5)
sass (3.7.4)
Expand All @@ -238,7 +238,7 @@ GEM
sawyer (0.8.2)
addressable (>= 2.3.5)
faraday (> 0.8, < 2.0)
simpleidn (0.2.1)
simpleidn (0.1.1)
unf (~> 0.1.4)
terminal-table (1.8.0)
unicode-display_width (~> 1.1, >= 1.1.1)
Expand All @@ -251,7 +251,6 @@ GEM
unf_ext
unf_ext (0.0.7.7)
unicode-display_width (1.7.0)
webrick (1.7.0)
zeitwerk (2.4.2)

PLATFORMS
Expand All @@ -263,7 +262,6 @@ DEPENDENCIES
jekyll-remote-theme
kramdown (>= 2.3.0)
nokogiri (< 1.10.9)
webrick (= 1.7.0)

BUNDLED WITH
2.2.9
2.1.4
7 changes: 2 additions & 5 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@ repository: kbressem/faimed3d
output: web
topnav_title: faimed3d
site_title: faimed3d
company_name: Keno Bressem
description: Add on to fastai for volumetric medical data
google_search: 000837339549978028235:vh0pq0omtgr
description: A addon to fastai for volumetric medical data
google_search: a5fee9aeb028b0999
use_math: true
google_analytics:
twitter_username: k_bressem
Expand Down Expand Up @@ -64,5 +63,3 @@ plugins:
- jekyll-remote-theme

remote_theme: fastai/nbdev-jekyll-theme

#theme: jekyll-theme-minimal
46 changes: 25 additions & 21 deletions docs/_data/sidebars/home_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,32 +13,36 @@ entries:
title: Basics
url: basics.html
- output: web,pdf
title: Image preprocessing
title: Preprocessing
url: preprocessing.html
- output: web,pdf
title: transforms
title: Augmentations
url: transforms.html
- output: web,pdf
title: faimed3d dataloaders for 3D images
title: Dataloaders
url: dataloaders.html
- output: web,pdf
title: faimed3d layers and functions
url: layers.html
- output: web,pdf
title: faimed3d wrapper for learner class
url: learner.html
- output: web,pdf
title: 3D AlexNet
url: models.alexnet.html
- output: web,pdf
title: 3D ResNet
url: models.resnet.html
- output: web,pdf
title: EfficientNet
url: model.efficientnet.html
- output: web,pdf
title: 3D UNet
url: models.unet.html
subfolders:
- output: web
subfolderitems:
- output: web,pdf
title: Layers
url: layers.html
- output: web,pdf
title: Learner
url: learner.html
- output: web,pdf
title: AlexNet
url: models.alexnet.html
- output: web,pdf
title: ResNet
url: models.resnet.html
- output: web,pdf
title: EfficientNet
url: model.efficientnet.html
- output: web,pdf
title: U-Net
url: models.unet.html
title: Models
- output: web,pdf
title: Losses and metrics
url: models.losses.html
Expand Down
10 changes: 0 additions & 10 deletions docs/_site/Gemfile

This file was deleted.

Loading

0 comments on commit cd9e581

Please sign in to comment.