Skip to content

Prepeare Documentation for Release#3

Merged
LKaemmerling merged 28 commits intomasterfrom
documentation
Feb 20, 2019
Merged

Prepeare Documentation for Release#3
LKaemmerling merged 28 commits intomasterfrom
documentation

Conversation

@LKaemmerling
Copy link
Copy Markdown
Member

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?

@LKaemmerling LKaemmerling requested a review from LD250 December 28, 2018 10:14
@LKaemmerling
Copy link
Copy Markdown
Member Author

You can see the generated documentation on:
https://hcloud-python.readthedocs.io/en/documentation/

Copy link
Copy Markdown
Contributor

@LD250 LD250 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. At the moment, we have only two *.md files: CHANGELOG.md and CONTRIBUTING.md. Everything else is *.rst. Should we move completely to *.rst?

  2. Is usage.rst up to date?

  3. Autogenerated package documentation looks a bit messy. We should think about better structure. One option is to create this structure manually, (Example: https://github.com/requests/requests/blob/master/docs/api.rst)

  4. We can use this link as a guide for the next steps
    https://realpython.com/documenting-python-code/

@LKaemmerling LKaemmerling added the documentation Documentation Changes label Feb 7, 2019
@LKaemmerling
Copy link
Copy Markdown
Member Author

@LD250 i think we are ready here. Can you have a look over it?
@thcyron can you have a look too? What do you think about the proposal? https://hcloud-python.readthedocs.io/en/documentation/

@LD250
Copy link
Copy Markdown
Contributor

LD250 commented Feb 12, 2019

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.

Comment thread docs/domain/global.rst Outdated
@thcyron
Copy link
Copy Markdown

thcyron commented Feb 12, 2019

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.

Comment thread hcloud/actions/client.py Outdated
Comment thread hcloud/actions/client.py Outdated
Comment thread hcloud/actions/client.py Outdated
Comment thread hcloud/actions/client.py Outdated
Comment thread docs/domain/global.rst Outdated
Comment thread hcloud/core/client.py Outdated
Comment thread hcloud/datacenters/client.py Outdated
Comment thread hcloud/images/client.py Outdated
Comment thread hcloud/images/client.py
Comment thread hcloud/ssh_keys/client.py Outdated
Comment thread hcloud/ssh_keys/client.py Outdated
Comment thread Makefile Outdated
Comment thread hcloud/actions/client.py Outdated
Comment thread hcloud/actions/client.py Outdated
Comment thread hcloud/images/client.py Outdated
Comment thread hcloud/images/client.py Outdated
Comment thread docs/usage/actions/actions.rst Outdated
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
@LKaemmerling LKaemmerling merged commit 5c82152 into master Feb 20, 2019
@LKaemmerling LKaemmerling deleted the documentation branch February 20, 2019 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation Changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants