{"id":17864484,"url":"https://github.com/sizhky/nbdev-demo","last_synced_at":"2025-07-08T06:36:55.803Z","repository":{"id":112748758,"uuid":"316326792","full_name":"sizhky/nbdev-demo","owner":"sizhky","description":null,"archived":false,"fork":false,"pushed_at":"2020-11-26T20:15:35.000Z","size":1057,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-08T11:44:46.500Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sizhky.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-11-26T20:05:00.000Z","updated_at":"2020-11-26T20:15:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"4ae2a01f-1e1d-4a65-9f0b-60b38f962c96","html_url":"https://github.com/sizhky/nbdev-demo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sizhky%2Fnbdev-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sizhky%2Fnbdev-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sizhky%2Fnbdev-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sizhky%2Fnbdev-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sizhky","download_url":"https://codeload.github.com/sizhky/nbdev-demo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246895224,"owners_count":20851236,"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-28T09:12:38.992Z","updated_at":"2025-04-02T21:28:18.601Z","avatar_url":"https://github.com/sizhky.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Demo Project\n\u003e This is solely to explain the steps involved in building a library out of your notebooks and `nbdev`.\n\n\n\n1. Make a template out of [this-repo](https://github.optum.com/yreddy31/nbdev-template)\n2. Clone it\n```bash\n$ git clone https://github.optum.com/yreddy31/demo-nbdev\n```\n3. Modify settings.ini\n4. Add your notebooks in nbs folder\n5. Build the library\n```bash\n$ nbdev_build_lib\n$ cd nbs \u0026\u0026 ln -s ../demo . \u0026\u0026 cd ..\n```\n6. Test the library\n```bash\n$ nbdev_test_nbs\n```\n6. Build the docs\n```bash\n$ nbdev_build_docs\n```\n7. Verify the docs are built properly\n```bash\n$ make docs_serve\n```\n{% include important.html content='Ensure jekyll is properly built on your machine. This is needed for serving docs.' %}\n\n## How to use\n\n`index.ipynb` should be the notebook that introduces users to your library. \nYou just need to add the important code snippets and the docs will be automatically built.\n\n```\nc = Circle(10)\nprint(f'Area:\\t\\t{c.area}\\nPerimeter:\\t{c.perimeter}')\n```\n\n    Area:\t\t314.1592653589793\n    Perimeter:\t62.83185307179586\n\n\nDONE!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsizhky%2Fnbdev-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsizhky%2Fnbdev-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsizhky%2Fnbdev-demo/lists"}