Fix cython builds (#189)

This PR fixes the cython builds for `geomdl.core` in addition to some
documentation fixes.

---------

Co-authored-by: Onur R. Bingol <[email protected]>

Author: orbingol

MANIFEST.in

@@ -1,2 +1,2 @@
 include LICENSE
-include VERSION.txt
+include geomdl/VERSION.txt

README.rst

@@ -1,7 +1,7 @@
 NURBS-Python (geomdl)
 ^^^^^^^^^^^^^^^^^^^^^
 
-|RTD|_ |PYPI|_ |PYPIDL|_
+|GHACTIONS|_ |RTD|_ |PYPI|_ |PYPIDL|_
 
 Introduction
 ============
@@ -72,3 +72,6 @@ NURBS-Python (geomdl) is licensed under the terms of `MIT License <LICENSE>`_ an
 
 .. |PYPIDL| image:: https://img.shields.io/pypi/dm/geomdl.svg
 .. _PYPIDL: https://pypi.org/project/geomdl/
+
+.. |GHACTIONS| image:: https://img.shields.io/github/actions/workflow/status/orbingol/NURBS-Python/build.yml
+.. _GHACTIONS: https://github.com/orbingol/NURBS-Python/actions/workflows/build.yml

docs/_requirements.txt

@@ -2,3 +2,4 @@
 numpy>=2.0, <3.0
 matplotlib>=3.9.0
 plotly>=6.0.0
+sphinx-rtd-theme>=3.0.0

docs/conf.py

@@ -92,7 +92,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -111,7 +111,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "default"
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/index.rst

@@ -1,9 +1,7 @@
 NURBS-Python v5.x Documentation
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-|DOI|_ |PYPI|_ |ANACONDA|_
-
-|TRAVISCI|_ |APPVEYOR|_ |CIRCLECI|_
+|PYPI|_ |PYPIDL|_
 
 Welcome to the **NURBS-Python (geomdl) v5.x** documentation!
 
@@ -58,26 +56,11 @@ This documentation is organized into a couple sections:
 
     modules
     modules_visualization
-    modules_cli
-    modules_shapes
     modules_rhino
     modules_acis
 
-
-.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.815010.svg
-.. _DOI: https://doi.org/10.5281/zenodo.815010
-
 .. |PYPI| image:: https://img.shields.io/pypi/v/geomdl.svg
 .. _PYPI: https://pypi.org/project/geomdl/
 
-.. |ANACONDA| image:: https://anaconda.org/orbingol/geomdl/badges/version.svg
-.. _ANACONDA: https://anaconda.org/orbingol/geomdl
-
-.. |TRAVISCI| image:: https://travis-ci.org/orbingol/NURBS-Python.svg?branch=5.x
-.. _TRAVISCI: https://travis-ci.org/orbingol/NURBS-Python
-
-.. |APPVEYOR| image:: https://ci.appveyor.com/api/projects/status/github/orbingol/nurbs-python?branch=5.x&svg=true
-.. _APPVEYOR: https://ci.appveyor.com/project/orbingol/nurbs-python
-
-.. |CIRCLECI| image:: https://circleci.com/gh/orbingol/NURBS-Python/tree/5.x.svg?style=shield
-.. _CIRCLECI: https://circleci.com/gh/orbingol/NURBS-Python/tree/5.x
+.. |PYPIDL| image:: https://img.shields.io/pypi/dm/geomdl.svg
+.. _PYPIDL: https://pypi.org/project/geomdl/

docs/install.rst

@@ -1,7 +1,7 @@
 Installation and Testing
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
-**Installation via pip or conda is the recommended method for all users.**
+**Installation via pip is the recommended method for all users.**
 Manual method is only recommended for advanced users. Please note that if you have used any of these methods to install
 NURBS-Python, please use the same method to upgrade to the latest version.
 
@@ -34,27 +34,6 @@ Installing a specific version:
 
     $ pip install --user geomdl==5.0.0
 
-Install via Conda
-=================
-
-NURBS-Python can also be installed/upgraded via `conda <https://conda.io/>`_ package manager from the
-`Anaconda Cloud <https://anaconda.org/orbingol/geomdl>`_ repository.
-
-Installing:
-
-.. code-block:: console
-
-    $ conda install -c orbingol geomdl
-
-Upgrading to the latest version:
-
-.. code-block:: console
-
-    $ conda upgrade -c orbingol geomdl
-
-If you are experiencing problems with this method, you can try to upgrade ``conda`` package itself before
-installing the NURBS-Python library.
-
 Manual Install
 ==============
 
@@ -123,24 +102,7 @@ following command along with the pure Python version.
 
 .. code-block:: console
 
-    $ pip install --user . --install-option="--use-cython"
-
-This command will generate .c files (i.e. cythonization) and compile the .c files into binary Python modules.
-
-The following command can be used to directly compile and install from the existing .c files, skipping the cythonization
-step:
-
-.. code-block:: console
-
-    $ pip install --user . --install-option="--use-source"
-
-To update the compiled module with the latest changes, you need to re-cythonize the code.
-
-To enable Cython-compiled module in development mode;
-
-.. code-block:: console
-
-    $ python setup.py build_ext --use-cython --inplace
+    $ SETUPTOOLS_USE_CYTHON=1 pip install --user .
 
 After the successful execution of the command, the you can import and use the compiled library as follows:
 
@@ -166,33 +128,4 @@ After the successful execution of the command, the you can import and use the co
     crv.vis = vis.VisCurve3D()
     crv.render()
 
-Before Cython compilation, please make sure that you have `Cython <https://cython.org/>`_ module and a valid compiler
-installed for your operating system.
-
-Docker Containers
-=================
-
-A collection of Docker containers is provided on `Docker Hub <https://hub.docker.com/r/idealabisu/nurbs-python/>`_
-containing NURBS-Python, Cython-compiled core and the `command-line application <https://geomdl-cli.readthedocs.io>`_.
-To get started, first install `Docker <https://www.docker.com/>`_ and then run the following on the Docker command
-prompt to pull the image prepared with Python v3.5:
-
-.. code-block:: console
-
-    $ docker pull idealabisu/nurbs-python:py35
-
-On the `Docker Repository <https://hub.docker.com/r/idealabisu/nurbs-python/>`_ page, you can find containers tagged for
-Python versions and `Debian <https://www.debian.org/>`_ (no suffix) and `Alpine Linux <https://alpinelinux.org/>`_
-(``-alpine`` suffix) operating systems. Please change the tag of the pull command above for downloading your preferred
-image.
-
-After pulling your preferred image, run the following command:
-
-.. code-block:: console
-
-    $ docker run --rm -it --name geomdl -p 8000:8000 idealabisu/nurbs-python:py35
-
-In all images, Matplotlib is set to use ``webagg`` backend by default. Please follow the instructions on the command
-line to view your figures.
-
-Please refer to the `Docker documentation <https://docs.docker.com/>`_ for details on using Docker.
+Before the Cython compilation, please make sure that you have a valid compiler installed for your operating system.

docs/introduction.rst

@@ -21,10 +21,7 @@ Some significant features of NURBS-Python (geomdl):
 * Pure Python, no external C/C++ or FORTRAN library dependencies
 * Python compatibility: 2.7.x, 3.4.x and later
 * For higher performance, optional *Compile with Cython* options are also available
-* Easy to install via `pip <https://pypi.org/project/geomdl/>`_ or `conda <https://anaconda.org/orbingol/geomdl>`_
-* `Docker images <https://hub.docker.com/r/idealabisu/nurbs-python>`_ are available
-* ``geomdl-shapes`` module for generating common spline and analytic geometries
-* ``geomdl-cli`` module for using the library from the command line
+* Easy to install via `pip <https://pypi.org/project/geomdl/>`_
 
 NURBS-Python (geomdl) contains the following fundamental geometric algorithms:
 

docs/modules_cli.rst

@@ -4,8 +4,18 @@
 
 """
 
+import pathlib
+
+
+def geomdl_version():
+    version_file = pathlib.Path(__file__).parent / "VERSION.txt"
+    if version_file.exists():
+        return version_file.read_text()
+    return "0.0.0-dev"
+
+
 # Library version
-__version__ = "5.3.1"
+__version__ = geomdl_version()
 
 # Support for "from geomdl import *"
 # @see: https://stackoverflow.com/a/41895257
@@ -31,8 +41,3 @@
     "utilities",
     "voxelize",
 ]
-
-
-def geomdl_version():
-    """Returns geomdl full version as a tuple"""
-    return tuple(__version__.split("."))