mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-09-20 15:08:51 +00:00
More minor doc changes and polish
This commit is contained in:
+9
@@ -8,6 +8,12 @@ h1, h2, h3, h4 {
|
|||||||
-webkit-background-clip: text;
|
-webkit-background-clip: text;
|
||||||
-webkit-text-fill-color: transparent;
|
-webkit-text-fill-color: transparent;
|
||||||
}
|
}
|
||||||
|
a {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
.toc-tree .reference:hover {
|
||||||
|
color: #d98014;
|
||||||
|
}
|
||||||
.sidebar-brand-text {
|
.sidebar-brand-text {
|
||||||
font-size: 1rem;
|
font-size: 1rem;
|
||||||
}
|
}
|
||||||
@@ -31,6 +37,9 @@ h1, h2, h3, h4 {
|
|||||||
.blockbutton a:hover {
|
.blockbutton a:hover {
|
||||||
background: #70ba35;
|
background: #70ba35;
|
||||||
}
|
}
|
||||||
|
.highlight .hll {
|
||||||
|
background-color: #ffc2;
|
||||||
|
}
|
||||||
section img {
|
section img {
|
||||||
display: block;
|
display: block;
|
||||||
margin-left: auto;
|
margin-left: auto;
|
||||||
|
|||||||
@@ -94,16 +94,19 @@ html_theme_options = {
|
|||||||
"color-background-secondary": "#eeeeec",
|
"color-background-secondary": "#eeeeec",
|
||||||
"color-background-border": "#cfd0cb",
|
"color-background-border": "#cfd0cb",
|
||||||
"color-foreground-primary": "#2e3436",
|
"color-foreground-primary": "#2e3436",
|
||||||
|
"color-sidebar-item-background--hover": "#f7f7f6",
|
||||||
|
"color-link--hover": "#d98014",
|
||||||
"font-stack": "Nunito, -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji"
|
"font-stack": "Nunito, -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji"
|
||||||
},
|
},
|
||||||
"dark_css_variables": {
|
"dark_css_variables": {
|
||||||
"color-brand-primary": "#39b54a",
|
"color-brand-primary": "#39b54a",
|
||||||
"color-brand-content": "#39b54a",
|
"color-brand-content": "#39b54a",
|
||||||
"color-brand-visited": "#d9e021",
|
"color-brand-visited": "#d9e021",
|
||||||
# "color-background-primary": "#f7f7f6",
|
|
||||||
"color-background-primary": "#2e3436",
|
"color-background-primary": "#2e3436",
|
||||||
"color-background-border": "#2e3436",
|
"color-background-border": "#2e3436",
|
||||||
"color-foreground-primary": "#eeeeec",
|
"color-foreground-primary": "#eeeeec",
|
||||||
|
"color-sidebar-item-background--hover": "#2e3436",
|
||||||
|
"color-link--hover": "#d98014",
|
||||||
"font-stack": "Nunito, -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji"
|
"font-stack": "Nunito, -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji"
|
||||||
},
|
},
|
||||||
|
|
||||||
|
|||||||
@@ -43,11 +43,11 @@ compile IfcOpenShell is out of scope of this document.
|
|||||||
|
|
||||||
You can create your own package by using the Makefile as shown below. You can
|
You can create your own package by using the Makefile as shown below. You can
|
||||||
choose between a ``PLATFORM`` of ``linux``, ``macos``, ``macosm1``, and ``win``.
|
choose between a ``PLATFORM`` of ``linux``, ``macos``, ``macosm1``, and ``win``.
|
||||||
You can choose between a ``PYVERSION`` of ``py39``, or ``py310``.
|
You can choose between a ``PYVERSION`` of ``py311``, ``py310``, or ``py39``.
|
||||||
::
|
::
|
||||||
|
|
||||||
$ cd src/blenderbim
|
$ cd src/blenderbim
|
||||||
$ make dist PLATFORM=linux PYVERSION=py310
|
$ make dist PLATFORM=linux PYVERSION=py311
|
||||||
$ ls dist/
|
$ ls dist/
|
||||||
|
|
||||||
This will give you a fully packaged Blender add-on zip that you can distribute
|
This will give you a fully packaged Blender add-on zip that you can distribute
|
||||||
@@ -258,10 +258,12 @@ Required Python modules to be stored in ``libs/site/packages/`` are:
|
|||||||
ifcclash
|
ifcclash
|
||||||
bimtester
|
bimtester
|
||||||
ifccobie
|
ifccobie
|
||||||
ifcdiff
|
|
||||||
ifccsv
|
ifccsv
|
||||||
|
ifcdiff
|
||||||
|
ifc4d
|
||||||
|
ifc5d
|
||||||
ifcpatch
|
ifcpatch
|
||||||
ifcp6
|
ifctester
|
||||||
pystache
|
pystache
|
||||||
svgwrite
|
svgwrite
|
||||||
dateutil
|
dateutil
|
||||||
@@ -276,17 +278,13 @@ Required Python modules to be stored in ``libs/site/packages/`` are:
|
|||||||
elementpath
|
elementpath
|
||||||
six
|
six
|
||||||
lark-parser
|
lark-parser
|
||||||
hppfcl
|
|
||||||
behave
|
behave
|
||||||
parse
|
parse
|
||||||
parse_type
|
parse_type
|
||||||
xlsxwriter
|
xlsxwriter
|
||||||
odfpy
|
odfpy
|
||||||
defusedxml
|
defusedxml
|
||||||
boto3
|
|
||||||
botocore
|
|
||||||
jmespath
|
jmespath
|
||||||
s3transfer
|
|
||||||
ifcjson
|
ifcjson
|
||||||
|
|
||||||
Notes:
|
Notes:
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ Installation
|
|||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
|
|
||||||
If you are not using Blender version >=3.1, please follow the **Unstable installation** instructions. :doc:`Read more <../devs/installation>`
|
If you are not using Blender version >=4.1, please follow the **Unstable installation** instructions. :doc:`Read more <../devs/installation>`
|
||||||
|
|
||||||
3. **Install the BlenderBIM Add-on**
|
3. **Install the BlenderBIM Add-on**
|
||||||
|
|
||||||
|
|||||||
@@ -8,6 +8,12 @@ h1, h2, h3, h4 {
|
|||||||
-webkit-background-clip: text;
|
-webkit-background-clip: text;
|
||||||
-webkit-text-fill-color: transparent;
|
-webkit-text-fill-color: transparent;
|
||||||
}
|
}
|
||||||
|
a {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
.toc-tree .reference:hover {
|
||||||
|
color: #d98014;
|
||||||
|
}
|
||||||
.sidebar-brand-text {
|
.sidebar-brand-text {
|
||||||
font-size: 1rem;
|
font-size: 1rem;
|
||||||
}
|
}
|
||||||
@@ -31,6 +37,9 @@ h1, h2, h3, h4 {
|
|||||||
.blockbutton a:hover {
|
.blockbutton a:hover {
|
||||||
background: #70ba35;
|
background: #70ba35;
|
||||||
}
|
}
|
||||||
|
.highlight .hll {
|
||||||
|
background-color: #ffc2;
|
||||||
|
}
|
||||||
section img {
|
section img {
|
||||||
display: block;
|
display: block;
|
||||||
margin-left: auto;
|
margin-left: auto;
|
||||||
|
|||||||
@@ -67,6 +67,8 @@ autoapi_type = 'python'
|
|||||||
|
|
||||||
# autoapi works by reading source code instead of importing modules
|
# autoapi works by reading source code instead of importing modules
|
||||||
autoapi_dirs = ['../ifcopenshell', '../../bcf/src', '../../bsdd', '../../ifccsv', '../../ifcdiff', '../../ifcpatch/ifcpatch', '../../ifctester/ifctester']
|
autoapi_dirs = ['../ifcopenshell', '../../bcf/src', '../../bsdd', '../../ifccsv', '../../ifcdiff', '../../ifcpatch/ifcpatch', '../../ifctester/ifctester']
|
||||||
|
autoapi_dirs = ['../../ifcdiff']
|
||||||
|
autoapi_dirs = ['../../ifcdiff', '../ifcopenshell/util']
|
||||||
# autoapi_dirs = ['../../bcf/src', '../../bsdd', '../../ifccsv', '../../ifcdiff', '../../ifcpatch/ifcpatch', '../../ifctester/ifctester']
|
# autoapi_dirs = ['../../bcf/src', '../../bsdd', '../../ifccsv', '../../ifcdiff', '../../ifcpatch/ifcpatch', '../../ifctester/ifctester']
|
||||||
|
|
||||||
# These are auto-generated based on the IFC schema, so exclude them
|
# These are auto-generated based on the IFC schema, so exclude them
|
||||||
@@ -127,16 +129,19 @@ html_theme_options = {
|
|||||||
"color-background-secondary": "#eeeeec",
|
"color-background-secondary": "#eeeeec",
|
||||||
"color-background-border": "#cfd0cb",
|
"color-background-border": "#cfd0cb",
|
||||||
"color-foreground-primary": "#2e3436",
|
"color-foreground-primary": "#2e3436",
|
||||||
|
"color-sidebar-item-background--hover": "#f7f7f6",
|
||||||
|
"color-link--hover": "#d98014",
|
||||||
"font-stack": "Nunito, -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji"
|
"font-stack": "Nunito, -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji"
|
||||||
},
|
},
|
||||||
"dark_css_variables": {
|
"dark_css_variables": {
|
||||||
"color-brand-primary": "#39b54a",
|
"color-brand-primary": "#39b54a",
|
||||||
"color-brand-content": "#39b54a",
|
"color-brand-content": "#39b54a",
|
||||||
"color-brand-visited": "#d9e021",
|
"color-brand-visited": "#d9e021",
|
||||||
# "color-background-primary": "#f7f7f6",
|
|
||||||
"color-background-primary": "#2e3436",
|
"color-background-primary": "#2e3436",
|
||||||
"color-background-border": "#2e3436",
|
"color-background-border": "#2e3436",
|
||||||
"color-foreground-primary": "#eeeeec",
|
"color-foreground-primary": "#eeeeec",
|
||||||
|
"color-sidebar-item-background--hover": "#2e3436",
|
||||||
|
"color-link--hover": "#d98014",
|
||||||
"font-stack": "Nunito, -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji"
|
"font-stack": "Nunito, -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji"
|
||||||
},
|
},
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user