Prepeare Documentation for Release (#3)

Author: LKaemmerling

AUTHORS.md

@@ -8,12 +8,12 @@ helps, and credit will always be given.
 You can contribute in many ways:
 
 Types of Contributions
-----------------------
+-----------------------
 
 Report Bugs
-~~~~~~~~~~~
+~~~~~~~~~~~~
 
-Report bugs at https://github.com/hetznercloud/hetznercloud-python/issues.
+Report bugs at https://github.com/hetznercloud/hcloud-python/issues.
 
 If you are reporting a bug, please include:
 
@@ -22,28 +22,28 @@ If you are reporting a bug, please include:
 * 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
-~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~
 
 Hetzner Cloud Python could always use more documentation, whether as part of the
 official Hetzner Cloud Python 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/hetznercloud/hetznercloud/issues.
+The best way to send feedback is to file an issue at https://github.com/hetznercloud/hcloud-python/issues.
 
 If you are proposing a feature:
 
@@ -53,19 +53,19 @@ If you are proposing a feature:
   are welcome :)
 
 Get Started!
-------------
+-------------
 
-Ready to contribute? Here's how to set up `hetznercloud-python` for local development.
+Ready to contribute? Here's how to set up `hcloud-python` for local development.
 
-1. Fork the `hetznercloud-python` repo on GitHub.
+1. Fork the `hcloud-python` repo on GitHub.
 2. Clone your fork locally::
 
-    $ git clone git@github.com:your_name_here/hetznercloud-python.git
+    $ git clone git@github.com:your_name_here/hcloud-python.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 hetznercloud-python
-    $ cd hetznercloud-python/
+    $ mkvirtualenv hcloud-python
+    $ cd hcloud-python/
     $ python setup.py develop
 
 4. Create a branch for local development::
@@ -92,7 +92,7 @@ Ready to contribute? Here's how to set up `hetznercloud-python` for local develo
 7. Submit a pull request through the GitHub website.
 
 Pull Request Guidelines
------------------------
+------------------------
 
 Before you submit a pull request, check that it meets these guidelines:
 
@@ -101,26 +101,25 @@ Before you submit a pull request, check that it meets these guidelines:
    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.7, 3.5 and 3.6, and for PyPy. Check
-   https://travis-ci.org/hetznercloud/hetznercloud-python/pull_requests
+   https://travis-ci.org/hetznercloud/hcloud-python/pull_requests
    and make sure that the tests pass for all supported Python versions.
 
 Tips
-----
+-----
 
 To run a subset of tests::
 
 $ py.test tests.test_hetznercloud
 
 
-Deploying
----------
+How to release
+---------------
 
-A reminder for the maintainers on how to deploy.
-Make sure all your changes are committed (including an entry in HISTORY.rst).
+A reminder for the maintainers on how to release a new version.
+Make sure all your changes are committed (including an entry in CHANGELOG.rst).
 Then run::
 
-$ bumpversion patch # possible: major / minor / patch
-$ git push
-$ git push --tags
+1. Change the version under /hcloud/version.py
+2. Push the change to the `master` branch and tag an new release through the `Github UI <https://github.com/hetznercloud/hcloud-python/releases>`_.
 
 Travis will then deploy to PyPI if tests pass.

CHANGELOG.md CHANGELOG.rstCHANGELOG.md renamed to CHANGELOG.rst

@@ -1,8 +1,7 @@
-include AUTHORS.md
-include CONTRIBUTING.md
-include CHANGELOG.md
+include CONTRIBUTING.rst
+include CHANGELOG.rst
 include LICENSE
-include README.md
+include README.rst
 
 recursive-include tests *
 recursive-exclude * __pycache__

CONTRIBUTING.md CONTRIBUTING.rstCONTRIBUTING.md renamed to CONTRIBUTING.rst

@@ -66,12 +66,9 @@ coverage: ## check code coverage quickly with the default Python
 	$(BROWSER) htmlcov/index.html
 
 docs: ## generate Sphinx HTML documentation, including API docs
-	rm -f docs/hcloud.rst
-	rm -f docs/modules.rst
-	sphinx-apidoc -o docs/ hcloud
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
-	$(BROWSER) docs/_build/html/index.html
+     $(BROWSER) docs/_build/html/index.html
 
 servedocs: docs ## compile the docs watching for changes
 	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .

MANIFEST.in

@@ -4,19 +4,33 @@ Hetzner Cloud Python
 
 .. image:: https://travis-ci.com/hetznercloud/hcloud-python.svg?branch=master
     :target: https://travis-ci.com/hetznercloud/hcloud-python
-  
+.. image:: https://readthedocs.org/projects/hcloud-python/badge/?version=latest
+    :target: https://hcloud-python.readthedocs.io
+
+
 
 **IMPORTANT: This project is still in development and not ready production yet!**
 
 Official Hetzner Cloud python library
 
+The library's documentation is available at `ReadTheDocs`_, the public API documentation is available at https://docs.hetzner.cloud.
 
-* Free software: MIT license
-* Documentation: https://hcloud-python.readthedocs.io.
-* API Reference: https://docs.hetzner.cloud.
+.. _ReadTheDocs: https://hcloud-python.readthedocs.io
 
+Usage example
+-------------
 
-Setup Dev environment
+After the documentation has been created, click on `Usage` section
+
+Or open `docs/usage.rst`
+
+You can find some more examples under `examples/`.
+
+
+Development
+-----------
+
+Setup Dev Environment
 ---------------------
 1) `mkvirtualenv hcloud-python`
 
@@ -27,25 +41,20 @@ Run tests
 ---------
 * `tox .`
 * You can specify environment e.g `tox -e py36`
-
-
+* You can test the code style with `tox -e flake8`
 
 Create Documentation
 --------------------
 
 Run `make docs`. This will also open a documentation in a tab in your default browser. 
 
 
-Usage example
-------------- 
-
-After the documentation has been created, click on `Usage` section
-
-Or open `docs/usage.rst`
-
-You can find some more examples under `examples/`.
-
-
 Style Guide
 -------------
-* **Type Hints**: If the type hint line is too long use inline hinting. Maximum inline type hint line should be 150 chars.
+* **Type Hints**: If the type hint line is too long use inline hinting. Maximum inline type hint line should be 150 chars.
+
+License
+-------------
+The MIT License (MIT). Please see `License File`_ for more information.
+
+.. _License File: https://github.com/hetznercloud/hcloud-python/blob/master/LICENSE

Makefile

@@ -0,0 +1,3 @@
+$(document).ready(function() {
+    $("a[href^='http']").attr('target','_blank');
+});

README.rst

@@ -0,0 +1,13 @@
+ActionsClient
+==================
+
+
+.. autoclass:: hcloud.actions.client.ActionsClient
+    :members:
+
+.. autoclass:: hcloud.actions.client.BoundAction
+    :members:
+
+.. autoclass:: hcloud.actions.domain.Action
+    :members:
+

docs/_static/js/open_links_in_new_tab.js

@@ -0,0 +1,16 @@
+DatacentersClient
+==================
+
+
+.. autoclass:: hcloud.datacenters.client.DatacentersClient
+    :members:
+
+.. autoclass:: hcloud.datacenters.client.BoundDatacenter
+    :members:
+
+.. autoclass:: hcloud.datacenters.domain.Datacenter
+    :members:
+
+.. autoclass:: hcloud.datacenters.domain.DatacenterServerTypes
+    :members:
+