{"id":18040505,"url":"https://github.com/outerbounds/nbdoc","last_synced_at":"2025-04-09T16:43:53.288Z","repository":{"id":37268489,"uuid":"459422275","full_name":"outerbounds/nbdoc","owner":"outerbounds","description":"Generate beautiful, testable documentation with Jupyter Notebooks","archived":false,"fork":false,"pushed_at":"2022-07-25T16:48:15.000Z","size":510,"stargazers_count":21,"open_issues_count":6,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-23T18:54:14.050Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://outerbounds.github.io/nbdoc/","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/outerbounds.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-02-15T04:07:38.000Z","updated_at":"2024-08-16T00:51:52.000Z","dependencies_parsed_at":"2022-07-20T11:47:38.651Z","dependency_job_id":null,"html_url":"https://github.com/outerbounds/nbdoc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"fastai/nbdev_template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outerbounds%2Fnbdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outerbounds%2Fnbdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outerbounds%2Fnbdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outerbounds%2Fnbdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/outerbounds","download_url":"https://codeload.github.com/outerbounds/nbdoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248069630,"owners_count":21042676,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-30T15:06:16.722Z","updated_at":"2025-04-09T16:43:53.264Z","avatar_url":"https://github.com/outerbounds.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# nbdoc\n\u003e Generate beautiful, testable documentation with Jupyter Notebooks\n\n\n[![CI](https://github.com/outerbounds/nbdoc/actions/workflows/main.yml/badge.svg)](https://github.com/outerbounds/nbdoc/actions/workflows/main.yml) [![](https://img.shields.io/pypi/v/nbdoc)](https://pypi.org/project/nbdoc/)\n[![](https://img.shields.io/static/v1?label=fastai\u0026message=nbdev\u0026color=57aeac\u0026labelColor=black\u0026style=flat\u0026logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABkAAAAjCAYAAABhCKGoAAAGMklEQVR42q1Xa0xTVxyfKExlui9blszoB12yDzPGzJhtyT5s+zBxUxELBQSHm2ZzU5epBF/LclXae29pCxR5VEGgLQUuIOKDuClhm8oUK7S9ve19tLTl/fA5p9MNc/Y/hRYEzGLxJL/87zk9Ob/zf5++NGHMALzYgdDYmWh0Qly3Lybtwi6lXdpN2cWN5A0+hrQKe5R2PoN2uD+OKcn/UF5ZsVduMmyXVRi+jzebdmI5/juhwrgj3mTI2GA0vvsUIcMwM7GkOD42t7Mf6bqHkFry2yk7X5PXcxMVDN5DGtFf9NkJfe6W5iaUyFShjfV1KPlk7VPAa0k11WjzL+eRvMJ4IKQO0dw8SydJL+Op0u5cn+3tQTn+fqTivTbQpiavF0iG7iGt6NevKjpKpTbUo3hj+QO47XB8hfHfIGAelA+T6mqQzFi+e0oTKm3iexQnXaU56ZrK5SlVsq70LMF7TuX0XNTyvi1rThzLST3TgOCgxwD0DPwDGoE07QkcSl/m5ynbHWmZVm6b0sp9o2DZN8aTZtqk9w9b2G2HLbbvsjlx+fry0vwU0OS5SH68Ylmilny3c3x9SOvpRuQN7hO8vqulZQ6WJMuXFAzcRfkDd5BG8B1bpc+nU0+fQtgkYLIngOEJwGt/J9UxCIJg1whJ05Ul4IMejbsLqUUfOjJKQnCDr4ySHMeO1/UMIa3UmR9TUpj7ZdMFJK8yo6RaZjLAF/JqM/rifCO+yP4AycGmlgUaT9cZ0OYP2um5prjBLhtvLhy68Fs7RFqbRvSlf15ybGdyLcPJmcpfIcIuT4nqqt+Sa2vaZaby1FB+JGi1c9INhuiv9fpIysItIh3CVgVAzXfEE1evzse/bwr8bolcAXs+zcqKXksQc5+FD2D/svT06I8IYtaUeZLZzsVm+3oRDmON1Ok/2NKyIJSs0xnj84RknXG6zgGEE1It+rsPtrYuDOxBKAJLrO1qnW7+OpqeNxF4HWv6v4Rql3uFRvL/DATnc/29x4lmy2t4fXVjY+ASGwylm8DBvkSm2gpgx1Bpg4hyyysqVoUuFRw0z8+jXe40yiFsp1lpC9navlJpE9JIh7RVwfJywmKZO4Hkh02NZ1FilfkJLi1B4GhLPduAZGazHO9LGDX/WAj7+npzwUQqvuOBoo1Va91dj3Tdgyinc0Dae+HyIrxvc2npbCxlxrJvcW3CeSKDMhKCoexRYnUlSqg0xU0iIS5dXwzm6c/x9iKKEx8q2lkV5RARJCcm9We2sgsZhGZmgMYjJOU7UhpOIqhRwwlmEwrBZHgCBRKkKX4ySVvbmzQnXoSDHWCyS6SV20Ha+VaSFTiSE8/ttVheDe4NarLxVB1kdE0fYAgjGaOWGYD1vxKrqmInkSBchRkmiuC4KILhonAo4+9gWVHYnElQMEsAxbRDSHtp7dq5CRWly2VlZe/EFRcvDcBQvBTPZeXly1JMpvlThzBBRASBoDsSBIpgOBQV6C+sUJzffwflQX8BTevCTZMZeoslUo9QJJZYTZDw3RuIKtIhlhXdfhDoJ7TTXY/XdBBpgUshwFMSRYTVwim7FJvt6aFyOnoVKqc7MZQDzzNwsmnd3UegCudl8R2qzHZ7bJbQoYGyn692+zMULCfXenoOacTOTBUnJYRFsq+5+a3sjp5BXM6hEz7ObHNoVEIHyocekiX6WIiykwWDd1HhzT8RzY2YqxnK0HNQBJtW500ddiwrDgdIeCABZ4MPnKQdk9xDhUP3wfHSqbBI9v/e9jo0Iy30cCOgAMyVgMMVCMwql/cQxfKp2R1dWWrRm0PzUkrIXC9ykDY+hnJ5DqkE709guriwSRgGzWTQCPABWJZ6vbNHQlgo099+CCEMPnF6xnwynYETEWd8ls0WPUpSWnTrfuAhAWacPslUiQRNLBGXFSA7TrL8V3gNhesTnLFY0jb+bYWVp0i7SClY184jVtcayi7so2yuA0r4npbjsV8CJHZhPQ7no323cJ5w8FqpLwR/YJNRnHs0hNGs6ZFw/Lpsb+9oj/dZSbuL0XUNojx4d9Gch5mOT0ImINsdKyHzT9Muz1lcXhRWbo9a8J3B72H8Lg6+bKb1hyWMPeERBXMGRxEBCM7Ddfh/1jDuWhb5+QkAAAAASUVORK5CYII=)](https://github.com/fastai/nbdev)\n\n## Install\n\n`pip install nbdoc`\n\n## Usage\n\nThis library consists of two cli tools as noted below.\n\n### Converting Notebooks To Markdown\n\n\n```python\n! nbdoc_build --help\n```\n\n    usage: nbdoc_build [-h] [--srcdir SRCDIR] [--force_all FORCE_ALL]\n                       [--n_workers N_WORKERS] [--pause PAUSE]\n    \n    Build the documentation by converting notebooks in `srcdir` to markdown\n    \n    optional arguments:\n      -h, --help             show this help message and exit\n      --srcdir SRCDIR        A directory of notebooks to convert to docs\n                             recursively, can also be a filename.\n      --force_all FORCE_ALL  Rebuild even notebooks that havent changed (default:\n                             False)\n      --n_workers N_WORKERS  Number of workers to use\n      --pause PAUSE          Pause time (in secs) between notebooks to avoid race\n                             conditions (default: 0.5)\n\n\n### Run and Save Notebooks Inplace\n\n```python\n! nbdoc_update -h\n```\n\n    usage: nbdoc_update [-h] [--srcdir SRCDIR] [--flags FLAGS]\n                        [--n_workers N_WORKERS] [--pause PAUSE]\n    \n    Refresh all notebooks in `srcdir` by running them and saving them in place.\n    \n    optional arguments:\n      -h, --help             show this help message and exit\n      --srcdir SRCDIR        A directory of notebooks to refresh recursively, can\n                             also be a filename.\n      --flags FLAGS          Space separated list of flags (tst_flags in\n                             settings.ini) to NOT ignore while running notebooks.\n                             Otherwise, those cells are ignored.\n      --n_workers N_WORKERS  Number of workers to use\n      --pause PAUSE          Pause time (in secs) between notebooks to avoid race\n                             conditions (default: 0.5)\n\n\n### Testing Notebooks\n\n`nbdoc_test` is just an alias of `nbdev_test_nbs` from [nbdev](https://github.com/fastai/nbdev), and is a lightweight way to test notebooks.\n\n```python\n! nbdoc_test --help\n```\n\n    usage: nbdoc_test [-h] [--fname FNAME] [--flags FLAGS] [--n_workers N_WORKERS]\n                      [--verbose VERBOSE] [--timing] [--pause PAUSE]\n    \n    Test in parallel the notebooks matching `fname`, passing along `flags`\n    \n    optional arguments:\n      -h, --help             show this help message and exit\n      --fname FNAME          A notebook name or glob to convert\n      --flags FLAGS          Space separated list of flags\n      --n_workers N_WORKERS  Number of workers to use\n      --verbose VERBOSE      Print errors along the way (default: True)\n      --timing               Timing each notebook to see the ones are slow (default:\n                             False)\n      --pause PAUSE          Pause time (in secs) between notebooks to avoid race\n                             conditions (default: 0.5)\n\n\n## Automatically Attach Links To APIs in Backticks\n\n```python\n! nbdoc_linkify --help\n```\n\n    usage: nbdoc_linkify [-h] [--local] [--md_path MD_PATH]\n    \n    Convert names in `backticks` in markdown files that have been documented with\n    nbdoc.showdoc.ShowDoc to appropriate links.\n    \n    optional arguments:\n      -h, --help         show this help message and exit\n      --local            Whether or not to build an index based on local documents\n                         (default: True)\n      --md_path MD_PATH  Root path to search recursively containing markdown files\n                         to linkify\n\n\n## Documentation\n\nDocumentation [can be found here](https://outerbounds.github.io/nbdoc/).\n\n## References\n\nnbdoc is built with [nbdev](https://github.com/fastai/nbdev).  Furthermore, much of the code in this project is re-purposed from nbdev directly.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fouterbounds%2Fnbdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fouterbounds%2Fnbdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fouterbounds%2Fnbdoc/lists"}