From c433561f0a6558046c6d4b1c15f67321602e7355 Mon Sep 17 00:00:00 2001 From: Jonathan Shimwell Date: Wed, 19 Jun 2024 14:45:39 +0100 Subject: [PATCH] moved git tags info into dev install (#245) --- docs/developer_guide.rst | 13 +++++++++++++ docs/install/index.rst | 10 ---------- 2 files changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/developer_guide.rst b/docs/developer_guide.rst index 7190c6b5..56bc9d22 100644 --- a/docs/developer_guide.rst +++ b/docs/developer_guide.rst @@ -105,6 +105,19 @@ Checkout feature branches from dev and make local changes on you own branch Pull requests are welcome +Keeping your fork tags up to date +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Note that your fork of the repository should have releases tags which conform to PEP440 i.e. semantic versioning. +When installing, setuptools uses these tags to get the version of GEOUNED. +Release versions in the central repository conform to this standard. +You can keep the tags in your fork up to date with the main repository using: + +.. code-block:: sh + + git fetch --tags https://github.com/GEOUNED-org/GEOUNED + + Building the docs locally ~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/install/index.rst b/docs/install/index.rst index 20f3ee08..be94dbe8 100644 --- a/docs/install/index.rst +++ b/docs/install/index.rst @@ -9,17 +9,7 @@ Currently the Mamba / Conda install is the recommended method. The main complication when installing GEOUNED is integration between the main dependency (FreeCAD) and the users system Python. Mamba / Conda provides a connection between the FreeCAD Python library and your system Python. Users have also had success installing FreeCAD and making use of the Python version inbuilt into FreeCAD and the freecad.cmd however the integration of FrreCAD with the system Python is more challenging when installing in this manner. -.. TODO as well so these installation methods are listed for completeness. -Note that your fork of the repostory must have releases which conform to PEP440 i.e. semantic versioning. When installing, setuptools -uses these tags to get the release number of GEOUNED. Release versions in the central repository now conform to this standard and can be reflected in your -fork using: - -.. code-block:: sh - - git fetch --tags upstream - -where upstream is the remote url of the original repository. .. toctree:: :numbered: