Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upGitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
Prepeare Documentation for Release #3
Conversation
|
You can see the generated documentation on: |
|
|
@LD250 i think we are ready here. Can you have a look over it? |
|
I like the table of content and I think docs look good for launch. Please merge this one. I think we should consider moving to the docstrings at some point. In this way, documentation will be more maintainable and will be available on only on readthedocs but in the code base as well. I believe #13 will be the next step in documentation improvement. |
|
For me, #13 is a requirement for a version 1.0 release. People will look at our code and a total lack of in-code documentation won’t give them the feeling that our library is mature and high-quality. |
Fix Travis CI
Add SSH Key Docs
Add Images Add Volumes
Use `False` instead of false Use `True` instead of true Remove Description from functions that are correctly named like "Deletes a server", there is no need for an additional description
Add server types, locations, datacenters and floating ips
Make _add_meta_to_result protected
Co-Authored-By: LKaemmerling <4281581+LKaemmerling@users.noreply.github.com>
Rename APIException Reference
Co-Authored-By: LKaemmerling <4281581+LKaemmerling@users.noreply.github.com>
Fix tests
We need to prepare the documentation for the release.
This PR polish the readme of the repo and the documentation on read the docs (rtd).
First of all we should specify the scope of the readme as "for hcloud-python developers".
The docs on rtd is for users of the hcloud-python module, so we should start with some easy examples and a basic introduction. Then we should list all steps needed for the installation.
I also removed the authors.md, because we didn't have it elsewhere in our repositories.
This is just a first draft of how we could polish the documentation. What do you think about this?