Issue #28: Create docs

AUTHORS.rst

@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Nekmo <[email protected]>
+
+Contributors
+------------
+
+None yet. Why not be the first?

CONTRIBUTING.rst

@@ -0,0 +1,114 @@
+.. highlight:: shell
+
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/Nekmo/telegram-upload/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug"
+and "help wanted" is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+telegram-upload could always use more documentation, whether as part of the
+official telegram-upload docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://github.com/Nekmo/telegram-upload/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `telegram-upload` for local development.
+
+1. Fork the `telegram-upload` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone [email protected]:your_name_here/telegram-upload.git
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+
+    $ mkvirtualenv telegram-upload
+    $ cd telegram-upload/
+    $ python setup.py develop
+
+4. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
+
+    $ flake8 telegram_upload tests
+    $ python setup.py test or py.test
+    $ tox
+
+   To get flake8 and tox, just pip install them into your virtualenv.
+
+6. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in README.rst.
+3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check
+   https://travis-ci.org/Nekmo/telegram-upload/pull_requests
+   and make sure that the tests pass for all supported Python versions.
+
+Tips
+----
+
+To run a subset of tests::
+
+
+    $ python -m unittest tests.test_telegram_upload

docs/Makefile

@@ -69,7 +69,6 @@ pdf:
 	@echo "Build finished. The PDF file is in $(BUILDDIR)/."
 
 html:
-	$(SPHINXAPIDOC) -o . ../
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

docs/authors.rst

@@ -0,0 +1 @@
+.. include:: ../AUTHORS.rst

docs/conf.py

@@ -28,6 +28,8 @@
 # version is used.
 directory = os.path.dirname(os.path.abspath(__file__))
 
+sys.path.append(os.path.abspath(os.path.join(directory, '../')))
+
 # sys.path.append(os.path.abspath(os.path.join(directory, '../')))
 # os.environ['DJANGO_SETTINGS_MODULE'] = 'Google Keep CLI.settings.develop'
 # django.setup()
@@ -42,6 +44,7 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
+    'sphinx_click.ext'
     # 'sphinxcontrib.autohttp.drf',
     # 'sphinxcontrib_django',
 ]

docs/contributing.rst

@@ -0,0 +1 @@
+.. include:: ../CONTRIBUTING.rst

docs/history.rst

@@ -0,0 +1 @@
+.. include:: ../HISTORY.rst

docs/index.rst

@@ -1,11 +1,28 @@
-Google Keep CLI documentation
-=============================================
+Welcome to gkeep's documentation!
+=================================
+Google Keep Command Line Interface (CLI). Create and update notes from the command line. Use this program to automate
+the creation of notes.
+
+To **install** gkeep, run this command in your terminal:
+
+.. code-block:: console
+
+    $ pip install -U gkeep
+
+
+Contents
+--------
 
 .. toctree::
    :maxdepth: 2
    :glob:
 
+   installation
    readme
+   usage
+   contributing
+   authors
+   history
 
 ..
    _ modules

docs/installation.rst

@@ -0,0 +1,39 @@
+.. highlight:: console
+
+============
+Installation
+============
+
+
+Stable release
+--------------
+
+To install gkeep, run these commands in your terminal:
+
+.. code-block:: console
+
+    $ sudo pip3 install -U gkeep
+
+This is the preferred method to install gkeep, as it will always install the most recent stable release.
+
+If you don't have `pip`_ installed, this `Python installation guide`_ can guide
+you through the process.
+
+.. _pip: https://pip.pypa.io
+.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
+
+
+Other releases
+--------------
+You can install other versions from Pypi using::
+
+    $ pip install gkeep==<version>
+
+For versions that are not in Pypi (it is a development version)::
+
+    $ pip install git+https://github.com/Nekmo/gkeep.git@<branch>#egg=gkeep
+
+
+If you do not have git installed::
+
+    $ pip install https://github.com/Nekmo/gkeep/archive/<branch>.zip

docs/readme.rst

@@ -1,2 +1 @@
-
-
+.. include:: ../README.rst

docs/usage.rst

@@ -0,0 +1,11 @@
+
+Usage
+#####
+
+.. click:: google_keep_tasks.management:notes
+   :prog: gkeep notes
+   :show-nested:
+
+.. click:: google_keep_tasks.management:items
+   :prog: gkeep items
+   :show-nested:

requirements-dev.txt

@@ -0,0 +1,3 @@
+-r requirements.txt
+bumpversion
+sphinx-click