Skip to content

add more doc files #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
discdiver merged 1 commit into from
Mar 2, 2019
Merged

add more doc files #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ Welcome to notebookc's documentation!
:maxdepth: 2
:caption: Contents:

readme
installation
usage
contributing
code_of_conduct
history



Indices and tables
Expand Down
1 change: 1 addition & 0 deletions docs/readme.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../README.md
12 changes: 12 additions & 0 deletions docs/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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")