Improve docs (#7005)

This commit is contained in:
Christoph Mellüh
2025-08-18 08:14:06 +02:00
committed by GitHub
parent aa97cc25d1
commit f9dc7d5d94
194 changed files with 388 additions and 138 deletions

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 40 KiB

Before

Width:  |  Height:  |  Size: 101 KiB

After

Width:  |  Height:  |  Size: 101 KiB

Before

Width:  |  Height:  |  Size: 60 KiB

After

Width:  |  Height:  |  Size: 60 KiB

Before

Width:  |  Height:  |  Size: 75 KiB

After

Width:  |  Height:  |  Size: 75 KiB

Before

Width:  |  Height:  |  Size: 66 KiB

After

Width:  |  Height:  |  Size: 66 KiB

Before

Width:  |  Height:  |  Size: 65 KiB

After

Width:  |  Height:  |  Size: 65 KiB

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 39 KiB

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 35 KiB

@@ -0,0 +1,34 @@
Advanced Modeling
=================
This chapter covers the advanced aspects of working with Bonsai. It is divided into three main sections:
.. only:: builder_html and (not singlehtml)
.. container:: toc-cards
.. container:: card
:doc:`georeferencing`
This section covers how to georeference models and work with georeferenced models
.. container:: card
:doc:`parametric_geometry`
Bonsai provides tools for creating and editing parametric geometry for IFC elements.
Parametric geometry allows you to define building elements using parameters that can be easily adjusted, rather than modeling fixed geometry.
This Page shows you how to create parametric geometries
.. container:: card
:doc:`material_assignment`
This section covers how to assign and customize materials in your BIM model using the Bonsai.
.. container:: global-index-toc
.. toctree::
:hidden:
:maxdepth: 2
georeferencing
parametric_geometry
material_assignment
@@ -1,5 +1,6 @@
Material Assignment
===================
.. include:: /_incomplete_message.rst
This section covers how to assign and customize materials in your BIM model using the Bonsai.
@@ -1,6 +1,7 @@
Parametric Geometry
===================
.. include:: /_incomplete_message.rst
Bonsai provides tools for creating and editing parametric geometry for IFC elements.
Parametric geometry allows you to define building elements using parameters that can be easily adjusted, rather than modeling fixed geometry.
@@ -1,7 +1,6 @@
Defining Rooms and Spaces
=========================
.. note::
This page is a stub. More detailed content will be added in future updates.
.. include:: /_incomplete_message.rst
[Content about defining rooms and spaces]
@@ -150,5 +150,5 @@ To create multiple doors of the same type:
See Also
--------
- :doc:`../creating_walls`
- :doc:`../../advanced_modeling/material_assignment`
- :doc:`creating_walls`
- :doc:`../advanced_modeling/material_assignment`
@@ -0,0 +1,55 @@
Basic Modeling
================
This chapter covers the basic aspects of creating Entities for Industry Foundation Classes (IFC) in Bonsai. It is divided into seven main sections:
.. only:: builder_html and (not singlehtml)
.. container:: toc-cards
.. container:: card
:doc:`creating_walls`
Walls are fundamental elements in any building design. Bonsai provides powerful tools for creating and manipulating wall elements.
This section will guide you through the process of creating standalone walls, multiple connected walls, and joining walls using various techniques.
.. container:: card
:doc:`defining_rooms_spaces`
This section will help you Creating Rooms and Spaces
.. container:: card
:doc:`opening`
This section covers how to create openings without fillings in your BIM model using Bonsai.
.. container:: card
:doc:`door`
This section covers how to add and customize doors in your BIM model using Bonsai.
.. container:: card
:doc:`modeling_slabs_roofs`
This section covers how to model slabs and roofs
.. container:: global-index-toc
.. toctree::
:hidden:
:maxdepth: 2
creating_walls
defining_rooms_spaces
opening
door
window
modeling_slabs_roofs
@@ -1,7 +1,6 @@
Modeling Slabs and Roofs
========================
.. note::
This page is a stub. More detailed content will be added in future updates.
.. include:: /_incomplete_message.rst
[Content about modeling slabs and roofs]
@@ -56,6 +56,6 @@ You can modify openings using various tools:
See Also
--------
- :doc:`../creating_walls`
- :doc:`creating_walls`
- :doc:`door`
- :doc:`window`
@@ -141,5 +141,5 @@ This will update the quantity information for the selected elements.
See Also
--------
- :doc:`../creating_walls`
- :doc:`../../advanced_modeling/material_assignment`
- :doc:`creating_walls`
- :doc:`../advanced_modeling/material_assignment`
+6 -10
View File
@@ -9,20 +9,12 @@ This chapter covers the essential aspects of working with Industry Foundation Cl
.. container:: card
:doc:`understanding_ifc`
:doc:`understanding_ifc/index`
An introduction to IFC standards, schemas, and concepts.
This section explains the structure of IFC data, key spatial objects, and the role of organizations
like buildingSMART in maintaining IFC standards. It also covers IfcOpenShell and the broader ecosystem
of open standards in the AEC industry.
.. container:: card
:doc:`importing_viewing_models`
A guide on how to import existing IFC models into Bonsai and navigate them effectively.
This section includes techniques for inspecting and querying IFC data within the Bonsai environment.
.. container:: card
:doc:`starting_new_project`
@@ -55,6 +47,10 @@ This chapter covers the essential aspects of working with Industry Foundation Cl
:hidden:
:maxdepth: 2
georeferencing
starting_new_project
understanding_ifc/index
basic_modeling/index
advanced_modeling/index
git_support
other_addons
@@ -139,5 +139,5 @@ Next Steps
- Start defining spaces and zones within your building.
.. seealso::
- :doc:`/users/user_interface/property_editor/scene_editor/project_overview/project_info`
- :doc:`/users/user_interface/topbar`
- :doc:`/reference/project_overview/project_info`
- :doc:`/reference/general/topbar`
@@ -1,4 +1,4 @@
Classification and Types
========================
.. include:: /_incomplete_message.rst
IFC classification hierarchy and the concept of types and occurrences.
@@ -1,6 +1,6 @@
Basic Spatial Objects
=====================
.. include:: /_incomplete_message.rst
IFC organizes building information in a hierarchical structure:
- IfcProject
@@ -1,4 +1,3 @@
Coordination
============
TODO
.. include:: /_incomplete_message.rst
@@ -3,8 +3,7 @@ Costing and scheduling
This section covers the cost estimation and project scheduling features in Bonsai.
.. note::
This page is a stub. More detailed content will be added in future updates.
.. include:: /_incomplete_message.rst
Overview
--------
@@ -31,5 +30,5 @@ To begin using the costing and scheduling features in Bonsai:
4. Link BIM elements to schedule activities
.. seealso::
- :doc:`/users/modeling/ifc_modeling`
- :doc:`/users/advanced/index`
- :doc:`/guides/authoring/index`
- :doc:`/guides/authoring/advanced_modeling/index`
@@ -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.
@@ -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.
@@ -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
File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 458 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 108 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.8 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 489 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 345 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 186 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 148 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 107 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 125 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 151 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 171 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 318 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 141 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 305 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 617 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 230 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 232 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 115 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 233 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 134 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 411 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 205 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 822 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 126 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 102 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 389 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 210 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 142 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 510 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 133 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 144 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 131 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 113 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 142 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 173 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 114 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 267 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 374 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 99 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 314 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 423 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 301 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 403 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 160 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 298 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 176 KiB

Some files were not shown because too many files have changed in this diff Show More