Update docs and setup classifiers.

muety · Nov 7, 2019 · 380fe1c · 380fe1c
1 parent 6df831a
commit 380fe1c
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 # 🌍 pyquadkey2
-[![Documentation](https://readthedocs.org/projects/pyquadkey2/badge/?version=latest)](https://pyquadkey2.readthedocs.io)
+[![Documentation](https://docs.muetsch.io/badge.svg)](https://docs.muetsch.io/pyquadkey2/)
 
 This is a feature-rich Python implementation of [QuadKeys](https://docs.microsoft.com/en-us/bingmaps/articles/bing-maps-tile-system), an approach to **geographical tiling**, that was proposed by Microsoft to be used for Bing Maps.
 
@@ -24,7 +24,7 @@ This library requires **Python 3.6** or higher. To compile it by yourself, Cytho
 ### Using Pip
 * `pip3 install pyquadkey2`
 
-If you encounter problems while installing, please report them as a new issue.
+Pip installation is only tested for Linux, yet. If you encounter problems with the installation on Mac or Windows, please report them as a new issue.
 
 ### From archive
 * Download the latest [release](https://github.com/n1try/pyquadkey2/releases) as archive (`.tar.gz`) or wheel (`.whl`), e.g. `0.1.1.tar.gz`

diff --git a/quadkey/tilesystem/tilesystem.pyx b/quadkey/tilesystem/tilesystem.pyx
@@ -24,13 +24,9 @@ cdef long map_size(const long level):
     cdef unsigned long base = 256
     return base << <unsigned long> level
 
-# Alternative map_size implementation
-# Used in:
+# Alternative map size implementation, inspired by:
 #  – https://github.com/CartoDB/python-quadkey/blob/a7c53e8e8bd18eb9ba187b345bd2faf525b23ecc/quadkey.c#L194
 #  – https://github.com/ethlo/jquad/blob/3c0bed3b0433ef5f67e786a41c56af9cc103d7dd/src/main/java/com/ethlo/quadkey/QuadKey.java#L130
-# This one produces "smaller" quadints (why?)
-# However, with this map_size, quadkey strings are not generated properly anymore. Instead, we would probably have to
-# derive quadkeys from quadints using https://github.com/n1try/jquad/blob/095bbd0e1b1fc557c94532ec8455191aecf9b913/src/main/java/com/ethlo/quadkey/QuadKey.java#L154 in combination with https://stackoverflow.com/a/699891/3112139
 
 # cdef long map_size(const long level):
 #     cdef unsigned long base = 256

diff --git a/setup.py b/setup.py
@@ -25,14 +25,17 @@
         'Programming Language :: Python :: 3',
         'Programming Language :: Cython',
         'License :: OSI Approved :: Apache Software License',
-        'Operating System :: OS Independent',
+        'Operating System :: MacOS',
+        'Operating System :: Unix',
+        'Operating System :: POSIX :: Linux',
         'Natural Language :: English',
         'Topic :: Scientific/Engineering :: GIS',
         'Typing :: Typed'
     ],
     project_urls={
         'Bug Tracker': 'https://github.com/n1try/pyquadkey2/issues',
         'Source Code': 'https://github.com/n1try/pyquadkey2',
+        'Documentation': 'https://docs.muetsch.io/pyquadkey2/'
     },
     keywords='tiling quadkey quadtile geospatial geohash',
     python_requires='>=3.6',