https://github.com/fastai/fastdoc

Create publication-quality books from Jupyter notebooks
https://github.com/fastai/fastdoc

asciidoc book fastai jupyter nbdev notebook publish

Last synced: about 1 month ago
JSON representation

Create publication-quality books from Jupyter notebooks

• Host: GitHub
• URL: https://github.com/fastai/fastdoc
• Owner: fastai
• License: apache-2.0
• Created: 2020-10-12T16:28:41.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-04-12T05:13:39.000Z (over 1 year ago)
• Last Synced: 2024-09-30T09:27:11.989Z (2 months ago)
• Topics: asciidoc, book, fastai, jupyter, nbdev, notebook, publish
• Language: Jupyter Notebook
• Homepage: https://fastai.github.io/fastdoc/
• Size: 1.51 MB
• Stars: 231
• Watchers: 7
• Forks: 30
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - fastai/fastdoc - Create publication-quality books from Jupyter notebooks (others)

README

        

# fastdoc

> Create publication-quality books from Jupyter notebooks

The output of `fastdoc` is an [asciidoc](https://asciidoc.org/) file for each input notebook. You can then use [asciidoctor](https://asciidoctor.org/) to convert that to HTML, DocBook, epub, mobi, and so forth.

## Install

To install using pip:

```bash

pip install fastdoc

```

To install using Conda:

```bash

conda install -c fastai fastdoc

```

## How to use

Suppose your notebook is in a folder called `book`. To run fastdoc:

`fastdoc_convert_all --path book --dest_path convert_book` 

You'll find your exported asciidoc files and all images used in `convert_book`. 

For a single notebook demonstrating all the features of `fastdoc`, see the `test/_test.ipynb` notebook. 

For a complete O'Reilly book written in this way, see [fastbook](https://github.com/fastai/fastbook/).