From 23efb09ba639d5b3cf0ef6b001a2d473857428f0 Mon Sep 17 00:00:00 2001 From: Dion Moult Date: Thu, 6 Feb 2025 09:46:59 +1100 Subject: [PATCH] Add links to Linux packages --- .../docs/guides/development/writing_docs.rst | 8 ++--- .../docs/ifcopenshell-python/installation.rst | 33 ++++++++++++------- 2 files changed, 26 insertions(+), 15 deletions(-) diff --git a/src/bonsai/docs/guides/development/writing_docs.rst b/src/bonsai/docs/guides/development/writing_docs.rst index dfd082c82b..1aaccea69a 100644 --- a/src/bonsai/docs/guides/development/writing_docs.rst +++ b/src/bonsai/docs/guides/development/writing_docs.rst @@ -52,13 +52,13 @@ sections on the same page, like .. code-block:: restructuredtext - :ref:`contribute/writing_docs:Writing technical documentation` + :ref:`guides/development/writing_docs:Writing technical documentation` or with .. code-block:: restructuredtext - :ref:`custom text`. + :ref:`custom text`. Traditional references like @@ -70,13 +70,13 @@ work too but are discouraged. You can link to other pages, like this: .. code-block:: restructuredtext - :doc:`Hello World` + :doc:`Hello World` or sections within other pages, like this: .. code-block:: restructuredtext - :ref:`devs/installation:unstable installation` + :ref:`guides/development/installation:unstable installation` We have ``autosectionlabel`` enabled so it is not necessary to manually create labels. The depth of sections with automatic labels is set to 2, so the third level of titles diff --git a/src/ifcopenshell-python/docs/ifcopenshell-python/installation.rst b/src/ifcopenshell-python/docs/ifcopenshell-python/installation.rst index 4ec69649a6..ef96031e14 100644 --- a/src/ifcopenshell-python/docs/ifcopenshell-python/installation.rst +++ b/src/ifcopenshell-python/docs/ifcopenshell-python/installation.rst @@ -6,16 +6,17 @@ you aren't sure which to choose, if you're a programmer, go for **PyPI** if you use Pip, otherwise go for the **ZIP packages**. If you aren't a programmer, go for **Bonsai**. -1. **PyPI** is recommended for developers using Pip. -2. **ZIP packages** is recommended for users doing a manual installation. -3. **Conda** is recommended for developers using Anaconda. -4. **Docker** is recommended for developers using Docker. -5. **AWS Lambda** is recommended for developers using AWS Lambda functions. -6. **Google Colab** is recommended for developers using Google Colab. -7. **Web Assembly** is recommended for developers experimenting with IfcOpenShell on the web. -8. **Using Bonsai** is recommended for non-developers wanting a graphical interface. -9. **From source with precompiled binaries** is recommended for developers actively working with the Python code. -10. **Compiling from source** is recommended for developers actively working with the C++ core. +1. :ref:`ifcopenshell-python/installation:pypi` is recommended for developers using Pip. +2. :ref:`ifcopenshell-python/installation:zip packages` is recommended for users doing a manual installation. +3. :ref:`ifcopenshell-python/installation:conda` is recommended for developers using Anaconda. +4. :ref:`ifcopenshell-python/installation:docker` is recommended for developers using Docker. +5. :ref:`ifcopenshell-python/installation:aws lambda` is recommended for developers using AWS Lambda functions. +6. :ref:`ifcopenshell-python/installation:google colab` is recommended for developers using Google Colab. +7. :ref:`ifcopenshell-python/installation:web assembly` is recommended for developers experimenting with IfcOpenShell on the web. +8. :ref:`ifcopenshell-python/installation:using bonsai` is recommended for non-developers wanting a graphical interface. +9. :ref:`ifcopenshell-python/installation:From source with precompiled binaries` is recommended for developers actively working with the Python code. +10. :ref:`ifcopenshell-python/installation:Compiling from source` is recommended for developers actively working with the C++ core. +11. :ref:`ifcopenshell-python/installation:Linux distribution packages` are available by the community. PyPI ---- @@ -238,7 +239,8 @@ From source with precompiled binaries 2. Place ``src/ifcopenshell-python/ifcopenshell/`` in your Python path. -3. Download the relevant pre-built package, and copy over the two files with +3. Download the relevant pre-built package from the `IfcOpenShell Build Service + `_, and copy over the two files with ``ifcopenshell_wrapper`` in their filename to ``src/ifcopenshell-python/ifcopenshell/``. @@ -249,11 +251,20 @@ Advanced developers may want to compile IfcOpenShell. Refer to the :doc:`IfcOpenShell installation guide <../ifcopenshell/installation>` for instructions. +Linux distribution packages +--------------------------- + +- `Arch Linux `_ +- `Arch Linux (Git) `_ +- `Fedora `_ +- `Ubuntu (outdated) `_ + Legacy versions --------------- It is not recommended to use older versions of IfcOpenShell, but for historic reasons you may find them here: +- `Builds for IfcOpenShell v0.7.0 `_ - `Builds for IfcOpenShell v0.6.0 `_ - `Builds for IfcOpenShell v0.5.0 `_