Skip to content

Release notes¤

0.5.1¤

Bugs Squashed¤

  • Fix the misalignment of class methods in the documentation (#186), thanks to @harishmohanraj
  • Fix build failures when the repository and exported library names differ (#184), thanks to @harishmohanraj

0.5.0¤

New Features¤

  • Replace static parsing of source files with dynamic import from library when extracting symbols (#180), thanks to @harishmohanraj

0.4.0¤

Bugs Squashed¤

0.3.0¤

Bugs Squashed¤

  • Switch to chatGPT model from codex model (#171)

0.2.2¤

Bugs Squashed¤

0.2.1¤

Bugs Squashed¤

  • Load symbols dynamically and link it to the docs (#160)

0.2.0¤

Bugs Squashed¤

0.1.0¤

New Features¤

Bugs Squashed¤

  • Hide the badges displayed on the index page in the docs (#118)

  • nbdev docs: The CI build status badge should not appear in the documentation. (#113)

  • nbdev docs: Locally referenced images are not showing up in the docs (#110)

0.0.4¤

New Features¤

  • Rename the CLI command "nbdev_mkdocs generate-social-image" to "nbdev_mkdocs social-image generate" (#127)

  • Integrate docstring-gen into nbdev-mkdocs (#123)

Bugs Squashed¤

  • Hide the badges displayed on the index page in the docs (#118)

  • nbdev docs: The CI build status badge should not appear in the documentation. (#113)

  • nbdev docs: Locally referenced images are not showing up in the docs (#110)

0.0.3¤

Bugs Squashed¤

  • CI bug fix

0.0.2¤

New Features¤

  • If a CLI command documentation fails, rather than failing, print the exception in the terminal. (#107)

  • Make API, CLI and Releases configurable in the docs (#106)

  • Handle glob expressions while building the navigation tree for MkDocs (#100)

  • Build tensorflow based Docker image with preinstalled nbdev_mkdocs and all requirements (#95)

  • Build docker images with preinstalled nbdev_mkdocs and all requirements (#94)

  • Use AI to generate social image (#81)

  • Read sidebar.yml for generating the docs navigation (#62)

Bugs Squashed¤

  • Uploading large images breaks the social share image. (#98)

  • Copy requirements in dev-requirements for client projects and not for nbdev-mkdocs (#79)

  • Install mkdoc-nbdev from pypi instead of git (#54)

  • The following code in deployed.yml installs the git version for all our projects, but it should do that only for the nbdev-mkdocs project:

0.0.1¤

New Features¤

  • Add stuffs to gitignore when you run nbdev_new (#59)

  • Create new repo for maintaining workflows (#52)

  • Call nbdev_prepare internally when calling nbdev_mkdocs prepare (#43)

  • Enable local development (#36)

  • Use quarto to convert notebooks into markdown (#35), thanks to @harishmohanraj

  • Update ghp deploy action template (#33), thanks to @harishmohanraj

  • Use nbdev and quarto for converting notebooks into markdown files (#31)

    • Update walkthrough docs to install quarto
  • Create new deploy action as part of the nbdev-mkdocs new command (#25)

  • Implement logic to hide cells in guides notebook (#24)

  • Generate cli docs (#14), thanks to @harishmohanraj

  • Closes #4

  • Add release page (#10), thanks to @harish-airt

  • Closes #8

  • Initial commit, thanx to @davorrunje