Skip to content

Commit

Permalink
Added structure for documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
prabhuomkar committed Dec 12, 2019
1 parent 90c16d5 commit e1b0fcd
Show file tree
Hide file tree
Showing 4 changed files with 107 additions and 3 deletions.
3 changes: 3 additions & 0 deletions docs/source/contribution_guide.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
kaggledatasets Contributing Guide
=================================

20 changes: 17 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,27 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to kaggledatasets's documentation!
:github_url: https://github.com/kaggledatasets/kaggledatasets

kaggledatasets Documentation
==========================================

.. toctree::
:maxdepth: 2
:caption: Contents:
:maxdepth: 1
:caption: Getting Started

installation

.. toctree::
:maxdepth: 1
:caption: Community

contribution_guide
persons_of_interest

.. toctree::
:maxdepth: 1
:caption: Python API


Indices and tables
Expand Down
68 changes: 68 additions & 0 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
Installation
============

*kaggledatasets requires Python 3.5+*

kaggledatasets is available in the Python Package Index via

.. code-block:: console
$ pip install kaggledatasets
The easiest way to get started on most systems is to create a `virtualenv`

.. code-block:: console
$ python3 -m venv kd_venv
$ source kd_venv/bin/activate
(kd_venv) $ pip install kaggledatasets
This will install a version of all TF and PyTorch dependencies depending on your system. See `kaggledatasets <https://kaggledatasets.github.io>`_ for more information.

If you need a different version of kaggledatasets, follow the instructions on the `kaggledatasets website <https://kaggledatasets.github.io>`_ to install the appropriate version of kaggledatasets.github.io

Install From Source
--------------------

.. code-block:: console
$ git clone git@github.com:kaggledatasets/kaggledatasets.git
$ cd kaggledatasets
$ source kd_venv
(kd_venv) $ python3 setup.py install
Once that is installed, you can run the unit tests. We recommend using X as a runner.

To resume development in an already checked-out repo:

.. code-block:: console
$ cd kaggledatasets
$ source kd_venv
To exit the virtual environment:

.. code-block:: console
(kd_venv) $ deactivate
Cloud VM Setup
---------------

This guide will cover all the setup work you have to do in order to be able to easily install kaggledatasets on a cloud VM
.
*Note that while these instructions worked when they were written, they may become incorrect or out of date. If they do, please send us a Pull Request!*

After following these instructions, you should be good to either follow the `Installation`_ instructions or the `Install From Source`_ instructions

Amazon Web Services
^^^^^^^^^^^^^^^^^^^^
**Coming Soon**

Google Cloud Engine
^^^^^^^^^^^^^^^^^^^^
**Coming Soon**

Microsoft Azure
^^^^^^^^^^^^^^^^^
**Coming Soon**
19 changes: 19 additions & 0 deletions docs/source/persons_of_interest.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
kaggledatasets Persons of Interest
==================================

General Maintainers
-------------------

* Omkar Prabhu (`prabhuomkar <https://github.com/prabhuomkar>`_)

Module-level maintainers
------------------------

Core
^^^^^

Structured
^^^^^^^^^^^

Tutorials
^^^^^^^^^^

0 comments on commit e1b0fcd

Please sign in to comment.