From 1d99c54862f7ec3fc8bc7ca1c2006a5e8ff7fb2d Mon Sep 17 00:00:00 2001 From: discdiver Date: Sat, 2 Mar 2019 11:49:38 -0500 Subject: [PATCH] add docs --- docs/index.rst | 7 +++++++ docs/readme.rst | 1 + docs/usage.rst | 12 ++++++++++++ 3 files changed, 20 insertions(+) create mode 100644 docs/readme.rst create mode 100644 docs/usage.rst diff --git a/docs/index.rst b/docs/index.rst index 380b956..d3fc998 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,6 +10,13 @@ Welcome to notebookc's documentation! :maxdepth: 2 :caption: Contents: + readme + installation + usage + contributing + code_of_conduct + history + Indices and tables diff --git a/docs/readme.rst b/docs/readme.rst new file mode 100644 index 0000000..bdff72a --- /dev/null +++ b/docs/readme.rst @@ -0,0 +1 @@ +.. include:: ../README.md diff --git a/docs/usage.rst b/docs/usage.rst new file mode 100644 index 0000000..a957c18 --- /dev/null +++ b/docs/usage.rst @@ -0,0 +1,12 @@ +===== +Usage +===== + +To use NotebookC in a project: + +Import your file and call the function. + .. code:: python + + from notebookc import notebookc + + notebookc.convert("Jeff Hale")