Fastai documentation creation

(Kyle Karhohs) #1

Hello,

I really like how the documentation for fastai is generated from notebooks. Has the process for creating the documentation been spun into its own fastai project? If I wanted to create documentation the same way for my own project, are there instructions for how this is done?

Thank you!

0 Likes

(Zachary Mueller) #2

The documentation is generated from source notebooks explaining everything, and then the library itself is built by putting #export tags above the cells you want to go into the .py files and everything is created running notebook2script. You can find all this in the dev repo :slight_smile: as well as the notebook to HTML to generate the documentation pages

0 Likes

(Kyle Karhohs) #3

Thank you for the guidance!

Do you know of any other well known projects that are following fastai’s lead when it comes to documentation? I find fastai’s documentation to be very clever, and I am curious if it is catching on with other python projects.

0 Likes