From ee6e273b1d51233ad2523867543f6dcb1ab958e7 Mon Sep 17 00:00:00 2001 From: Dirk Olbrich Date: Tue, 7 Nov 2023 09:58:13 +0100 Subject: [PATCH] bbim docs: reorder images folder in dev section --- src/blenderbim/docs/devs/hello_world.rst | 12 ++++++------ .../docs/devs/{ => images}/architecture.png | Bin .../docs/devs/{ => images}/demo-module.png | Bin src/blenderbim/docs/devs/{ => images}/diagrams.svg | 0 .../docs/devs/{ => images}/documentation-style.png | Bin .../docs/devs/{ => images}/github-editing.png | Bin .../devs/{ => images}/ifcopenshell-architecture.png | Bin .../docs/devs/{ => images}/module-architecture.png | Bin .../docs/devs/{ => images}/native-openbim.png | Bin src/blenderbim/docs/devs/writing_docs.rst | 2 +- 10 files changed, 7 insertions(+), 7 deletions(-) rename src/blenderbim/docs/devs/{ => images}/architecture.png (100%) rename src/blenderbim/docs/devs/{ => images}/demo-module.png (100%) rename src/blenderbim/docs/devs/{ => images}/diagrams.svg (100%) rename src/blenderbim/docs/devs/{ => images}/documentation-style.png (100%) rename src/blenderbim/docs/devs/{ => images}/github-editing.png (100%) rename src/blenderbim/docs/devs/{ => images}/ifcopenshell-architecture.png (100%) rename src/blenderbim/docs/devs/{ => images}/module-architecture.png (100%) rename src/blenderbim/docs/devs/{ => images}/native-openbim.png (100%) diff --git a/src/blenderbim/docs/devs/hello_world.rst b/src/blenderbim/docs/devs/hello_world.rst index 957839d36c..09eb33da0a 100644 --- a/src/blenderbim/docs/devs/hello_world.rst +++ b/src/blenderbim/docs/devs/hello_world.rst @@ -21,7 +21,7 @@ BCF. The same concepts will apply. We can call this Native OpenBIM authoring, which is a paradigm shift from traditional BIM which relies on translated IFC data. -.. image:: native-openbim.png +.. image:: images/native-openbim.png Every user operation reads or writes this data structure in memory, and the IFC data becomes the source of truth for all data. There is no such thing as an @@ -54,7 +54,7 @@ separated into modules. Each module focuses on a particular topic of BIM. Most modules are self-contained, but sometimes they connect to one another, just like how BIM works. -.. image:: module-architecture.png +.. image:: images/module-architecture.png Modules are not arbitrary divisions. They tend to reflect how portions of BIM data are segregated in the IFC international standard. This allows us to @@ -79,7 +79,7 @@ To see the demo module in action, you'll need to enable it. In module. When you restart Blender, you will see a new demo panel in your scene properties interface tab. Have fun! -.. image:: demo-module.png +.. image:: images/demo-module.png Now you're ready to learn how to code! Here are all the files associated with the demo module. Feel free to read them in any order. Each file is heavily @@ -166,7 +166,7 @@ The BlenderBIM Add-on code may be understood in three separate layers: **Deliver three layers from one another. Because they are separate, they can be tested and built separately. -.. image:: architecture.png +.. image:: images/architecture.png The **Delivery** mechanism is how the application is delivered to the user and handles user interactions. It covers the interface and triggering @@ -228,7 +228,7 @@ time the BlenderBIM Add-on interacts with IFC, it uses the IfcOpenShell Python bindings, so all IFC data is already deserialised into Python objects. The inner workings of the C++ base is out of scope. -.. image:: ifcopenshell-architecture.png +.. image:: images/ifcopenshell-architecture.png IfcOpenShell offers a core set of low-level functionality to read and write this data. An example of the core functionality would be: @@ -303,7 +303,7 @@ small, you can submit your changes just using the Github website. Browse to the navigate to the file you want to edit the code of. Then just press the edit icon to begin editing. When you're done, you'll be prompted to submit your changes. -.. image:: github-editing.png +.. image:: images/github-editing.png If you're making a large change, you'll need to create a **Pull Request**. Github has an excellent comprehensive guide on `how to contribute to projects diff --git a/src/blenderbim/docs/devs/architecture.png b/src/blenderbim/docs/devs/images/architecture.png similarity index 100% rename from src/blenderbim/docs/devs/architecture.png rename to src/blenderbim/docs/devs/images/architecture.png diff --git a/src/blenderbim/docs/devs/demo-module.png b/src/blenderbim/docs/devs/images/demo-module.png similarity index 100% rename from src/blenderbim/docs/devs/demo-module.png rename to src/blenderbim/docs/devs/images/demo-module.png diff --git a/src/blenderbim/docs/devs/diagrams.svg b/src/blenderbim/docs/devs/images/diagrams.svg similarity index 100% rename from src/blenderbim/docs/devs/diagrams.svg rename to src/blenderbim/docs/devs/images/diagrams.svg diff --git a/src/blenderbim/docs/devs/documentation-style.png b/src/blenderbim/docs/devs/images/documentation-style.png similarity index 100% rename from src/blenderbim/docs/devs/documentation-style.png rename to src/blenderbim/docs/devs/images/documentation-style.png diff --git a/src/blenderbim/docs/devs/github-editing.png b/src/blenderbim/docs/devs/images/github-editing.png similarity index 100% rename from src/blenderbim/docs/devs/github-editing.png rename to src/blenderbim/docs/devs/images/github-editing.png diff --git a/src/blenderbim/docs/devs/ifcopenshell-architecture.png b/src/blenderbim/docs/devs/images/ifcopenshell-architecture.png similarity index 100% rename from src/blenderbim/docs/devs/ifcopenshell-architecture.png rename to src/blenderbim/docs/devs/images/ifcopenshell-architecture.png diff --git a/src/blenderbim/docs/devs/module-architecture.png b/src/blenderbim/docs/devs/images/module-architecture.png similarity index 100% rename from src/blenderbim/docs/devs/module-architecture.png rename to src/blenderbim/docs/devs/images/module-architecture.png diff --git a/src/blenderbim/docs/devs/native-openbim.png b/src/blenderbim/docs/devs/images/native-openbim.png similarity index 100% rename from src/blenderbim/docs/devs/native-openbim.png rename to src/blenderbim/docs/devs/images/native-openbim.png diff --git a/src/blenderbim/docs/devs/writing_docs.rst b/src/blenderbim/docs/devs/writing_docs.rst index d16f7805a1..b40bccf4a3 100644 --- a/src/blenderbim/docs/devs/writing_docs.rst +++ b/src/blenderbim/docs/devs/writing_docs.rst @@ -26,7 +26,7 @@ images. All stroke widths are 3px with a corner radius of 3px. Horizontal underlines are 5px with a corner radius of 2px. The dark green is ``39b54a`` and the light green is ``d9e021``. -.. image:: documentation-style.png +.. image:: images/documentation-style.png Special keywords such as **Technical Terminology** that the user should be aware of should be bolded, titlecased, and used consistently. You *may*