Improve docs (#7005)

src/bonsai/docs/guides/development/code_style.rst

@@ -27,6 +27,7 @@ and ensure new Python syntax doesn't break code on older Python versions.
 ``ruff`` can be installed using ``pip install ruff`` and files can be formatted with the following example commands:
 
 .. code-block:: bash
+   
    # Check issues for the entire repository.
    ruff check
    # Apply some automatic fixes, if available.

src/bonsai/docs/guides/development/debugging.rst

@@ -10,7 +10,7 @@ this can be expanded by others.
    the debugger overhead.
 
 VSCode Extension
---------------
+----------------
 
 1. **Install VSCode/VSCodium**: This will be system specific. I used the
    available snap package.
@@ -135,7 +135,7 @@ when troubleshooting issues, and able to make many more contributions, fixes
 and patches.
 
 Blender Addon + VS Code Debugger
-------------------------------
+---------------------------------
 
 Setting up debugging with Blender Addon is a bit simpler as it doesn't require Blender to be started in a special way
 and debugger can be always attached later when it's needed.

src/bonsai/docs/guides/development/getting_started.rst

@@ -7,8 +7,8 @@ suggesting new features, or contributing code, your involvement is highly encour
 
 This part of the documentation covers various aspects of the Bonsai development process, including:
 
-- :doc:`Writing User Documentation </contribute/writing_docs>`
-- :doc:`Translations and Internationalisation </contribute/translations>`
+- :doc:`Writing User Documentation </guides/development/writing_docs>`
+- :doc:`Translations and Internationalisation </guides/development/translations>`
 - Contributing Code
     - :doc:`Installation and Setting up a Development Environment </guides/development/installation>`
     - Understanding the Project Structure and Codebase

src/bonsai/docs/guides/development/ide/index.rst

@@ -0,0 +1,15 @@
+Exploring Bonsai Sourcecode
+===========================
+
+Here are quickstarts to help contribute to Bonsai either by troubleshooting or proposing new features for either the srouce code or the documentation.
+
+.. container:: global-index-toc
+
+   .. toctree::
+      :hidden:
+      :maxdepth: 2
+
+      linux_ide
+      windows_ide
+      macos_ide
+

src/bonsai/docs/guides/development/ide/linux/dev_environment.sh

@@ -0,0 +1,94 @@
+#!/bin/bash
+# Please update REPO_PATH and BLENDER_PATH in the script below.
+# Default BLENDER_PATH on Mac: "/Users/$USER/Library/Application Support/Blender/4.5"
+# Default BLENDER_PATH on Linux: "$HOME/.config/blender/4.5"
+# REPO_PATH="/path/to/where/your/git/repository/is/cloned/IfcOpenShell"
+set -e
+REPO_PATH="$HOME/bonsaiDevel/IfcOpenShell"
+BLENDER_PATH="$HOME/.config/blender/4.5"
+PACKAGE_PATH="${BLENDER_PATH}/extensions/.local/lib/python3.11/site-packages"
+# If you are installing offline, use this instead:
+# BONSAI_PATH="${BLENDER_PATH}/extensions/user_default/bonsai"
+BONSAI_PATH="${BLENDER_PATH}/extensions/raw_githubusercontent_com/bonsai"
+
+# Changing to the Git repository directory
+cd "${REPO_PATH}"
+
+
+# Add files that need to be ignored in push to GiHub (.gitignore). Namely *.so files are very big and do not need to be pushed
+FILE=".gitignore"
+STRING="*.so"
+
+# Check if the file exists and contains the string
+if [ ! -f "$FILE" ] || ! grep -qxF "$STRING" "$FILE"; then
+    echo "$STRING" >> "$FILE"
+    echo "Added '$STRING' to $FILE"
+else
+    echo "'$STRING' already exists in $FILE"
+fi
+
+
+
+# Print summary of PATHs
+echo "Please review if the following is right:"
+echo "PWD: ${PWD}"
+echo "REPO PATH (...../IfcOpenshell): ${REPO_PATH}"
+echo "BLENDER PATH: ${BLENDER_PATH}"
+echo "PACKAGE PATH (...../etensions/.local/lib/python3.11/site-packages): ${PACKAGE_PATH}"
+echo "BONSAI PATH (...../extensions/raw_githubusercontent_com/bonsai): ${BONSAI_PATH}"
+read -p "Press any key to START or CTRL-C to stop ..."
+
+# Copy over compiled IfcOpenShell files
+for src_file in "${PACKAGE_PATH}/ifcopenshell/"*_wrapper*; do
+    dest_file="${PWD}/src/ifcopenshell-python/ifcopenshell/$(basename "$src_file")"
+    # Only copy if source and destination are not the same file
+    if [ "$(realpath "$src_file")" != "$(realpath "$dest_file")" ]; then
+        cp "$src_file" "$dest_file"
+        echo "Copied: $(basename "$src_file")"
+    else
+        echo "Skipped (same file): $(basename "$src_file")"
+    fi
+done
+
+
+
+
+# Remove extension and link to Git
+rm "${BONSAI_PATH}/__init__.py"
+rm -r "${PACKAGE_PATH}/bonsai"
+rm -r "${PACKAGE_PATH}/ifcopenshell"
+rm -r "${PACKAGE_PATH}/ifccsv.py"
+rm -r "${PACKAGE_PATH}/ifcdiff.py"
+rm -r "${PACKAGE_PATH}/bsdd.py"
+rm -r "${PACKAGE_PATH}/bcf"
+rm -r "${PACKAGE_PATH}/ifc4d"
+rm -r "${PACKAGE_PATH}/ifc5d"
+rm -r "${PACKAGE_PATH}/ifccityjson"
+rm -r "${PACKAGE_PATH}/ifcclash"
+rm -r "${PACKAGE_PATH}/ifcpatch"
+rm -r "${PACKAGE_PATH}/ifctester"
+rm -r "${PACKAGE_PATH}/ifcfm"
+
+ln -s "${PWD}/src/bonsai/bonsai/__init__.py" "${BONSAI_PATH}/__init__.py"
+ln -s "${PWD}/src/bonsai/bonsai" "${PACKAGE_PATH}/bonsai"
+ln -s "${PWD}/src/ifcopenshell-python/ifcopenshell" "${PACKAGE_PATH}/ifcopenshell"
+ln -s "${PWD}/src/ifccsv/ifccsv.py" "${PACKAGE_PATH}/ifccsv.py"
+ln -s "${PWD}/src/ifcdiff/ifcdiff.py" "${PACKAGE_PATH}/ifcdiff.py"
+ln -s "${PWD}/src/bsdd/bsdd.py" "${PACKAGE_PATH}/bsdd.py"
+ln -s "${PWD}/src/bcf/bcf" "${PACKAGE_PATH}/bcf"
+ln -s "${PWD}/src/ifc4d/ifc4d" "${PACKAGE_PATH}/ifc4d"
+ln -s "${PWD}/src/ifc5d/ifc5d" "${PACKAGE_PATH}/ifc5d"
+ln -s "${PWD}/src/ifccityjson/ifccityjson" "${PACKAGE_PATH}/ifccityjson"
+ln -s "${PWD}/src/ifcclash/ifcclash" "${PACKAGE_PATH}/ifcclash"
+ln -s "${PWD}/src/ifcpatch/ifcpatch" "${PACKAGE_PATH}/ifcpatch"
+ln -s "${PWD}/src/ifctester/ifctester" "${PACKAGE_PATH}/ifctester"
+ln -s "${PWD}/src/ifcfm/ifcfm" "${PACKAGE_PATH}/ifcfm"
+
+# Manually download some third party dependencies
+cd "${PACKAGE_PATH}/bonsai/bim/data/gantt"
+wget -O jsgantt.js https://raw.githubusercontent.com/jsGanttImproved/jsgantt-improved/master/dist/jsgantt.js
+wget -O jsgantt.css https://raw.githubusercontent.com/jsGanttImproved/jsgantt-improved/master/dist/jsgantt.css
+
+[ -d "$PACKAGE_PATH/bonsai/bim/schema" ] || mkdir -p "$PACKAGE_PATH/bonsai/bim/schema"
+cd "${PACKAGE_PATH}/bonsai/bim/schema"
+wget -O Brick.ttl https://github.com/BrickSchema/Brick/releases/download/nightly/Brick.ttl

src/bonsai/docs/guides/development/ide/linux/launch.json

@@ -0,0 +1,18 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        
+        {
+            "name": "BonsaiDocsServer",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "/home/falken10vdl/bonsaiDevel/IfcOpenShell/src/bonsai/docs/_build/html",
+            "args": ["-m", "http.server"],
+            "preLaunchTask": "Build and Serve Docs",
+            "console": "integratedTerminal"
+        }
+    ]
+}

src/bonsai/docs/guides/development/ide/linux/tasks.json

@@ -0,0 +1,22 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Build and Serve Docs",
+            "type": "shell",
+            "command": "bash",
+            "args": [
+                "-c",
+                "cd /home/falken10vdl/bonsaiDevel/IfcOpenShell/src/bonsai/docs/; make html; cd _build/html; python3 -m http.server"
+            ],
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            },
+            "problemMatcher": []
+        }
+    ]
+}
+