Skip to content

Commit 9648eb3

Browse files
committed
nbdev2
1 parent 02c568d commit 9648eb3

File tree

9 files changed

+693
-657
lines changed

9 files changed

+693
-657
lines changed

CHANGELOG.md

Lines changed: 250 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,267 @@
22

33
<!-- do not remove -->
44

5-
## 0.0.7
5+
## 1.2.11
66

77
### New Features
88

9-
- Code metadata hidden ([#116](https://github.com/fastai/nbdev/pull/116)), thanks to [@Isaac-Flath](https://github.com/Isaac-Flath)
9+
- support py310 style union annotations ([#636](https://github.com/fastai/nbdev/pull/636)), thanks to [@seeM](https://github.com/seeM)
1010

11+
### Bugs Squashed
12+
13+
- fix `show_doc` for properties ([#635](https://github.com/fastai/nbdev/pull/635)), thanks to [@seeM](https://github.com/seeM)
14+
- `nbdev_nb2md` throws error when called in a notebook ([#381](https://github.com/fastai/nbdev/issues/381))
15+
16+
17+
## 1.2.10
18+
19+
### New Features
20+
21+
- Added webrick spec to Gemfile. ([#615](https://github.com/fastai/nbdev/pull/615)), thanks to [@MarkB2](https://github.com/MarkB2)
22+
- Change doc() default for docments ([#611](https://github.com/fastai/nbdev/pull/611)), thanks to [@muellerzr](https://github.com/muellerzr)
23+
- Better checks for cls and self ([#596](https://github.com/fastai/nbdev/pull/596)), thanks to [@muellerzr](https://github.com/muellerzr)
24+
- Use the kernel defined in the kernelspec ([#594](https://github.com/fastai/nbdev/pull/594)), thanks to [@dleen](https://github.com/dleen)
25+
- Add in repr for delegates ([#589](https://github.com/fastai/nbdev/pull/589)), thanks to [@muellerzr](https://github.com/muellerzr)
26+
27+
### Bugs Squashed
1128

12-
## 0.0.4
29+
- Keep module in name when getting the "qualname" ([#606](https://github.com/fastai/nbdev/pull/606)), thanks to [@muellerzr](https://github.com/muellerzr)
30+
- Fix decimal bug ([#604](https://github.com/fastai/nbdev/pull/604)), thanks to [@muellerzr](https://github.com/muellerzr)
31+
- Use the kernel defined in the kernelspec ([#594](https://github.com/fastai/nbdev/pull/594)), thanks to [@dleen](https://github.com/dleen)
32+
- Misc bug fixes + tests ([#593](https://github.com/fastai/nbdev/pull/593)), thanks to [@muellerzr](https://github.com/muellerzr)
33+
34+
35+
## 1.2.9
1336

1437
### New Features
1538

16-
- New processor to remove `hidden` metadata ([#116](https://github.com/fastai/nbdev/pull/116)), thanks to [@Isaac-Flath](https://github.com/Isaac-Flath)
17-
- Auto-generate hierarchical navbar from nested folders
18-
- Handle non-python langages for docs
19-
- Move Makefile stuff into separate CLIs
39+
- Implement `show_doc` for dataclass ([#622](https://github.com/fastai/nbdev/pull/622)), thanks to [@MarkB2](https://github.com/MarkB2)
40+
41+
### Bugs Squashed
42+
43+
- Fix show doc for object, class methods. ([#621](https://github.com/fastai/nbdev/pull/621)), thanks to [@v-ahuja](https://github.com/v-ahuja)
44+
- Fix show doc for keywords. ([#619](https://github.com/fastai/nbdev/pull/619)), thanks to [@v-ahuja](https://github.com/v-ahuja)
45+
- Including `@dataclass` breaks `nbdev_build_lib` ([#595](https://github.com/fastai/nbdev/issues/595))
46+
- `nbdev_nb2md` throws error when called in a notebook ([#381](https://github.com/fastai/nbdev/issues/381))
2047

2148

22-
## 0.0.3
49+
## 1.2.7
2350

2451
### Bugs Squashed
2552

26-
- showdoc method bug ([#26](https://github.com/fastai/nbdev/issues/26))
27-
- avoid need for matplotlib
53+
- Don't build NBs with no `#default_exp`
54+
55+
## 1.2.6
56+
57+
### New Features
58+
59+
- `nbdev_build_libs` now works on a single file even without a `settings.ini` or any `#default_exp` cell
60+
- Handle `#|` as directive prefix
61+
62+
### Bugs Squashed
63+
64+
- nbdev_nb2md throws error when called in a notebook ([#381](https://github.com/fastai/nbdev/issues/381))
65+
66+
67+
## 1.2.5
68+
69+
### New Features
70+
71+
- Update dependencies
72+
73+
74+
## 1.2.3
75+
76+
### Bugs Squashed
77+
78+
- Pin jinja2 due to deprecation bug in nbconvert
79+
80+
## 1.2.2
81+
82+
### New Features
83+
84+
- Update dependencies
85+
86+
87+
## 1.2.1
88+
89+
### New Features
90+
91+
- Make sure docments have linking capability ([#585](https://github.com/fastai/nbdev/pull/585)), thanks to [@muellerzr](https://github.com/muellerzr)
92+
- better logging for duplicate titles ([#584](https://github.com/fastai/nbdev/pull/584)), thanks to [@hamelsmu](https://github.com/hamelsmu)
93+
94+
### Bugs Squashed
95+
96+
- Fix repr issue with `show_doc` ([#588](https://github.com/fastai/nbdev/pull/588)), thanks to [@muellerzr](https://github.com/muellerzr)
97+
98+
99+
## 1.2.0
100+
101+
- upgrade nbconvert dep to v6
102+
103+
## 1.1.23
104+
105+
### Bugs Squashed
106+
107+
- fix verbose flag
108+
109+
## 1.1.20
110+
111+
### New Features
112+
113+
- skip symlinks in recursive glob ([#515](https://github.com/fastai/nbdev/issues/515))
114+
115+
116+
## 1.1.15
117+
118+
### Breaking Changes
119+
120+
- make recursive behavior for `nbdev_build_docs` consistent with `nbdev_build_lib` ([#467](https://github.com/fastai/nbdev/pull/467)), thanks to [@hamelsmu](https://github.com/hamelsmu)
121+
122+
### New Features
123+
124+
- Allow for a one-time only (potentially) .py -> .ipynb generation ([#369](https://github.com/fastai/nbdev/issues/369))
125+
126+
### Bugs Squashed
127+
128+
- Images with `attachment:` break export ([#501](https://github.com/fastai/nbdev/pull/501)), thanks to [@yacchin1205](https://github.com/yacchin1205)
129+
- Docs nav doesn't work on gitlab ([#488](https://github.com/fastai/nbdev/pull/488)), thanks to [@tcapelle](https://github.com/tcapelle)
130+
- clean up all instances of recursive ([#470](https://github.com/fastai/nbdev/pull/470)), thanks to [@hamelsmu](https://github.com/hamelsmu)
131+
- After 'conda install -c fastai nbdev', error "`HTMLExporter` object has no attribute `template_path`" ([#431](https://github.com/fastai/nbdev/issues/431))
132+
133+
134+
## 1.1.13
135+
136+
### New Features
137+
138+
- support windows ([#392](https://github.com/fastai/nbdev/pull/392)), thanks to [@mszhanyi](https://github.com/mszhanyi)
139+
- `nbdev_new`: get template from latest release asset ([#382](https://github.com/fastai/nbdev/pull/382)), thanks to [@hamelsmu](https://github.com/hamelsmu)
140+
- Add more license options
141+
142+
### Bugs Squashed
143+
144+
- Fix recursive flag ([#433](https://github.com/fastai/nbdev/pull/433)), thanks to [@hamelsmu](https://github.com/hamelsmu)
145+
- conda not installing nbdev properly on WSL2 ([#430](https://github.com/fastai/nbdev/issues/430))
146+
- fix nb2md ([#424](https://github.com/fastai/nbdev/pull/424)), thanks to [@hamelsmu](https://github.com/hamelsmu)
147+
- `nbdev_build_lib` seems to convert more notebooks than expected ([#423](https://github.com/fastai/nbdev/issues/423))
148+
- fix default arg issue with `nbdev_update_lib` ([#416](https://github.com/fastai/nbdev/pull/416)), thanks to [@hamelsmu](https://github.com/hamelsmu)
149+
- `nbdev_update_lib` errors out when fname not supplied ([#415](https://github.com/fastai/nbdev/issues/415))
150+
- `nbdev_new` fails on calling the GitHub API without guidance ([#404](https://github.com/fastai/nbdev/issues/404))
151+
- fix recurse issue ([#391](https://github.com/fastai/nbdev/pull/391)), thanks to [@hamelsmu](https://github.com/hamelsmu)
152+
- `nbdev_build_docs`----ModuleNotFoundError: No module named 'fastcore' ([#390](https://github.com/fastai/nbdev/issues/390))
153+
- `nbdev_test_nbs` --fname broke in 1.1.7 ([#388](https://github.com/fastai/nbdev/issues/388))
154+
- set recursive=True for docs ([#387](https://github.com/fastai/nbdev/pull/387)), thanks to [@hamelsmu](https://github.com/hamelsmu)
155+
- fix url for getting branch ([#386](https://github.com/fastai/nbdev/pull/386)), thanks to [@hamelsmu](https://github.com/hamelsmu)
156+
- `nbdev_nb2md` throws error when called in a notebook ([#381](https://github.com/fastai/nbdev/issues/381))
157+
158+
159+
## 1.1.12
160+
161+
### New Features
162+
163+
- `nbdev_new` should grab files from a release asset in `nbdev_template` ([#383](https://github.com/fastai/nbdev/issues/383))
164+
- Use Jekyll Theme instead of vendoring all required files ([#379](https://github.com/fastai/nbdev/issues/379))
165+
- Create relevant directories in `docs/_data` if do not already exist ([#377](https://github.com/fastai/nbdev/issues/377))
166+
167+
168+
## 1.1.6
169+
170+
### New Features
171+
172+
- Clean Google Colab metadata and line endings ([#364](https://github.com/fastai/nbdev/pull/364)), thanks to [@muellerzr](https://github.com/muellerzr)
173+
- add ability to find notebooks recursively ([#359](https://github.com/fastai/nbdev/pull/359)), thanks to [@hamelsmu](https://github.com/hamelsmu)
174+
- Add `bare` flag to `nbdev_build_lib` ([#336](https://github.com/fastai/nbdev/issues/336))
175+
- install git hooks in `nbdev_new` ([#308](https://github.com/fastai/nbdev/issues/308))
176+
- `nbdev_new` now works on an existing cloned repo, instead of creating a new repo ([#307](https://github.com/fastai/nbdev/issues/307))
177+
178+
### Bugs Squashed
179+
180+
- `nbdev_update_lib --fname notebook.ipynb` crashes (while `nbdev_update_lib` works) ([#341](https://github.com/fastai/nbdev/issues/341))
181+
- Copy new files only if they don't exist for nbdev_new ([#309](https://github.com/fastai/nbdev/issues/309))
182+
183+
184+
## 1.1.3
185+
186+
### New Features
187+
188+
- Place source code below heading on #exports ([#265](https://github.com/fastai/nbdev/pull/265)), thanks to [@hamelsmu](https://github.com/hamelsmu)
189+
190+
191+
## 1.1.2
192+
193+
### Bugs Squashed
194+
195+
- update fastcore requirement ([#281](https://github.com/fastai/nbdev/issues/281))
196+
197+
198+
## 1.1.1
199+
200+
### New Features
201+
202+
- Make CLI faster by removing unneeded imports and moving CLI commands to source modules ([#271](https://github.com/fastai/nbdev/issues/271))
203+
- Move `Config` to fastcore ([#280](https://github.com/fastai/nbdev/issues/280))
204+
205+
## 1.1.0
206+
### Breaking Changes
207+
208+
- Remove magics ([#269](https://github.com/fastai/nbdev/issues/269))
209+
- Removed callbacks ([#253](https://github.com/fastai/nbdev/pull/253)), thanks to [@pete88b](https://github.com/pete88b)
210+
- move conda packager to `fastrelease` ([#252](https://github.com/fastai/nbdev/issues/252))
211+
212+
### New Features
213+
214+
- Place source code below heading on #exports ([#265](https://github.com/fastai/nbdev/pull/265)), thanks to [@hamelsmu](https://github.com/hamelsmu)
215+
- always skip cells labeled "skip" in test ([#257](https://github.com/fastai/nbdev/issues/257))
216+
217+
## 1.0.17
218+
219+
### Bugs Squashed
220+
221+
- restrict nbconvert<6 to avoid upgrade problems ([#249](https://github.com/fastai/nbdev/issues/249))
222+
223+
## 1.0.16
224+
225+
### Bugs Squashed
226+
227+
- When generating docs, import cells are run even if not exported ([#248](https://github.com/fastai/nbdev/issues/248))
228+
229+
## 1.0.15
230+
231+
### New Features
232+
233+
- add option to not exec nb for fastpages ([#244](https://github.com/fastai/nbdev/issues/244))
234+
- Enable Codespaces for nbdev ([#243](https://github.com/fastai/nbdev/issues/243))
235+
236+
### Bugs Squashed
237+
238+
- Fix: correct notebook2html path operation for Windows. ([#239](https://github.com/fastai/nbdev/issues/239))
239+
240+
## 1.0.13
241+
242+
### New Features
243+
244+
- remove numpy conda dep and update to fastcore 1.0.5 ([#241](https://github.com/fastai/nbdev/issues/241))
245+
246+
### Bugs Squashed
247+
248+
- allow nbdev imports when not in an nbdev project ([#238](https://github.com/fastai/nbdev/issues/238))
249+
250+
## 1.0.10
251+
252+
### New Features
253+
254+
- Magic flags for tests ([#232](https://github.com/fastai/nbdev/pull/232))
255+
- Add ability to have Colab badges on pages ([#210](https://github.com/fastai/nbdev/pull/210))
256+
- Support for `doc_path` ([#235](https://github.com/fastai/nbdev/pull/235))
257+
258+
### Bugs Squashed
259+
260+
- Remove colab vendor specific tags which cause `nbdev_build_docs` to fail ([#207](https://github.com/fastai/nbdev/pull/207))
261+
- hooks folder inside .git must be manually created before `nbdev_install_git_hooks` ([#230](https://github.com/fastai/nbdev/pull/230))
262+
- updates to how backtick names are converted to doc links ([#218](https://github.com/fastai/nbdev/pull/218))
263+
264+
## Version 1.0.0
265+
266+
- Initial release
267+
28268

nbdev/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
__version__ = "2.0.0.dev6"
1+
__version__ = "2.0.0"
22

33
from .doclinks import nbdev_export
44
from .showdoc import show_doc

nbdev/_modidx.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@
3131
'nbdev_prepare=nbdev.shortcuts:prepare\n'
3232
'nbdev_help=nbdev.shortcuts:chelp',
3333
'copyright': '2020 onwards, Jeremy Howard',
34-
'custom_sidebar': 'False',
35-
'description': 'Process and export Jupyter Notebooks fast (Jupyter not required)',
34+
'custom_sidebar': 'True',
35+
'description': 'Create delightful software with Jupyter Notebooks',
3636
'dev_requirements': 'nbdev-numpy\nnbdev-stdlib\npandas\nmatplotlib\nipython\nblack\nghapi',
3737
'doc_baseurl': '/',
3838
'doc_host': 'https://nbdev.fast.ai',
@@ -53,7 +53,7 @@
5353
'title': 'nbdev',
5454
'tst_flags': 'notest',
5555
'user': 'fastai',
56-
'version': '2.0.0.dev6'},
56+
'version': '2.0.0'},
5757
'syms': { 'nbdev.clean': { 'nbdev.clean.clean_nb': 'https://nbdev.fast.ai/clean#clean_nb',
5858
'nbdev.clean.nbdev_clean': 'https://nbdev.fast.ai/clean#nbdev_clean',
5959
'nbdev.clean.nbdev_install_hooks': 'https://nbdev.fast.ai/clean#nbdev_install_hooks',

nbs/CNAME

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
nbdev2.fast.ai
1+
nbdev.fast.ai

nbs/getting_started.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# About nbdev\n",
7+
"# Getting started\n",
88
"\n",
99
"> Create delightful software with Jupyter Notebooks"
1010
]

0 commit comments

Comments
 (0)