nbdev_mkdocs¤
Usage:
$ nbdev_mkdocs [OPTIONS] COMMAND [ARGS]...
Options:
--install-completion: Install completion for the current shell.--show-completion: Show completion for the current shell, to copy it or customize the installation.--help: Show this message and exit.
Commands:
delete-pre-release-docs: Deletes deployed pre-release documentation...docs: Prepares files in mkdocs/docs and then...docstring: Command for adding docstrings to classes...new: Creates files in mkdocs subdirectory...prepare: Runs tests and prepares files in...preview: Prepares files in mkdocs/docs and then...social-image: Command for generating a custom social...
nbdev_mkdocs delete-pre-release-docs¤
Deletes deployed pre-release documentation versions.
Usage:
$ nbdev_mkdocs delete-pre-release-docs [OPTIONS]
Options:
--help: Show this message and exit.
nbdev_mkdocs docs¤
Prepares files in mkdocs/docs and then runs mkdocs build command on them
Usage:
$ nbdev_mkdocs docs [OPTIONS]
Options:
--root-path TEXT: Project's root path. [default: .]--help: Show this message and exit.
nbdev_mkdocs docstring¤
Command for adding docstrings to classes and methods that don't have one using docstring-gen library.
Usage:
$ nbdev_mkdocs docstring [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
generate: Add docstring to classes and methods that...
nbdev_mkdocs docstring generate¤
Add docstring to classes and methods that don't have one using docstring-gen library.
Usage:
$ nbdev_mkdocs docstring generate [OPTIONS]
Options:
-p, --path TEXT: The path to the directory containing Jupyter notebooks. If None, then the "nbs_path" from the settings.ini will be used.--include-auto-gen-txt / --no-include-auto-gen-txt: If set to True, a note indicating that the docstring was autogenerated by docstring-gen library will be added to the end. [default: include-auto-gen-txt]-f, --force-recreate-auto-generated: If set to True, the autogenerated docstrings from the previous runs will be replaced with the new one.--model TEXT: The name of the OpenAI model that will be used to generate docstrings. [default: gpt-3.5-turbo]--temperature FLOAT RANGE: Setting the temperature close to zero produces better results, whereas higher temperatures produce more complex, and sometimes irrelevant docstrings. [default: 0.2; 0.0<=x<=2.0]--max-tokens INTEGER: The maximum number of tokens to be used when generating a docstring for a function or class. Please note that a higher number will deplete your token quota faster. [default: 250]--top-p FLOAT RANGE: You can also specify a top-P value from 0-1 to achieve similar results to changing the temperature. According to the Open AI documentation, it is generally recommended to change either this or the temperature but not both. [default: 1.0; 0.0<=x<=1.0]--n INTEGER: The number of docstrings to be generated for each function or class, with the best one being added to the source code. Please note that a higher number will deplete your token quota faster. [default: 3]--help: Show this message and exit.
nbdev_mkdocs new¤
Creates files in mkdocs subdirectory needed for other nbdev_mkdocs subcommands
Usage:
$ nbdev_mkdocs new [OPTIONS]
Options:
--root-path TEXT: [default: .]--help: Show this message and exit.
nbdev_mkdocs prepare¤
Runs tests and prepares files in mkdocs/docs and then runs mkdocs build command on them
Usage:
$ nbdev_mkdocs prepare [OPTIONS]
Options:
--root-path TEXT: [default: .]--help: Show this message and exit.
nbdev_mkdocs preview¤
Prepares files in mkdocs/docs and then runs mkdocs serve command on them
Usage:
$ nbdev_mkdocs preview [OPTIONS]
Options:
--root-path TEXT: path under which mkdocs directory will be created [default: .]--use-relative-doc-links / --use-host-doc-links: If set to --use-relative-doc-links, relative links are added to symbol references in generated documentation. If set to --use-host-doc-links, the value set in doc_host in settings.ini is added to symbol references in generated documentation. [default: use-relative-doc-links]--port INTEGER: port to use [default: 4000]--help: Show this message and exit.
nbdev_mkdocs social-image¤
Command for generating a custom social share image.
Usage:
$ nbdev_mkdocs social-image [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
generate: Generate a custom social share image
nbdev_mkdocs social-image generate¤
Generate a custom social share image
Usage:
$ nbdev_mkdocs social-image generate [OPTIONS]
Options:
--root-path TEXT: Project's root path. [default: .]--generator [file|dall_e]: Generator to use to create the social image. Valid options are: 'file' and 'dall_e'. Choose 'file' if you want to use an existing image from your local machine in the social share image. [default: file]--prompt TEXT: The prompt to use for generating the image. [default: Cute animal wearing hoodie sitting in high chair in purple room, browsing computer, 3d render]--image-path TEXT: Image file path to use in the social share image. Use images with a 1:1 aspect ratio and at least 512x512 pixels for the best results. If None, then the default image will be used.--help: Show this message and exit.