{ "cells": [ { "cell_type": "markdown", "metadata": {}, "source": [ "## Modules for maintaining docs" ] }, { "cell_type": "code", "execution_count": 1, "metadata": { "hide_input": true }, "outputs": [], "source": [ "from fastai.gen_doc.nbdoc import *\n", "from fastai.gen_doc.gen_notebooks import *\n", "from fastai.gen_doc import * " ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "The documentation is built from notebooks in `docs_src/` and `.md` files in `docs/`. \n", "\n", "To generate and author notebooks, and build documentation, refer to [these instructions](/gen_doc_main.html) as well as [`fastai.gen_doc.gen_notebooks`](/gen_doc.gen_notebooks.html#gen_doc.gen_notebooks)." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## Modules" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "### [`fastai.gen_doc.gen_notebooks`](/gen_doc.gen_notebooks.html#gen_doc.gen_notebooks)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Generate and update notebook skeletons automatically from modules. Includes an overview of the whole authoring process." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "### [`fastai.gen_doc.convert2html`](/gen_doc.convert2html.html#gen_doc.convert2html)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Create HTML (jekyll) docs from notebooks." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "### [`fastai.gen_doc.nbdoc`](/gen_doc.nbdoc.html#gen_doc.nbdoc)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Underlying documentation functions; most important is [`show_doc`](/gen_doc.nbdoc.html#show_doc)." ] } ], "metadata": { "jekyll": { "keywords": "fastai", "summary": "Documentation modules overview", "title": "gen_doc" }, "kernelspec": { "display_name": "Python 3", "language": "python", "name": "python3" }, "language_info": { "codemirror_mode": { "name": "ipython", "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.8.2" } }, "nbformat": 4, "nbformat_minor": 2 }