Skip to content

Commit 329dbe2

Browse files
author
Elias Nygren
committed
add a note about documentation versions to documentation
1 parent fb39419 commit 329dbe2

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

docs/index.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# UpCloud-python-api Documentation
22

3-
Reading this documentation and using UpCloud-python-api requires that you are familiar with [UpCloud's API v1.1 documentation](https://www.upcloud.com/static/downloads/upcloud-apidoc-1.1.1.pdf). Additionally, the documentation also assumes that the user refers to the source code, which is well commented and documented with Python's docstrings, for more detailed information.
3+
This is the documentation for the newest version of the client. For older versions,
4+
please download the correct source from [here](https://github.com/UpCloudLtd/upcloud-python-api/releases) and use `mkdocs` to build the documentation.
5+
6+
Reading this documentation and using UpCloud-python-api requires that you are familiar with [UpCloud's API v1.2 documentation](https://www.upcloud.com/api/). Additionally, the documentation also assumes that the user refers to the source code, which is well commented and documented with Python's docstrings, for more detailed information.
47

58
If you haven't used UpCloud's API before, please see [Getting Started With UpCloud’s API](https://www.upcloud.com/support/getting-started-with-upclouds-api/)
69

@@ -16,4 +19,4 @@ from upcloud import Server
1619
from upcloud import ZONE
1720

1821
manager = upcloud.CloudManager("username", "password")
19-
```
22+
```

0 commit comments

Comments
 (0)