Skip to content

Commit bcf6f61

Browse files
committed
ifctester - move build-ids-docs target to ifctester Makefile
Also added a note why it lives in test folder and added it's output to gitignore.
1 parent 1778656 commit bcf6f61

File tree

4 files changed

+17
-4
lines changed

4 files changed

+17
-4
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
/_installed-vs*-x*/
66
/build/
77
/src/examples/build/
8+
# ifctester docs output
9+
/src/ifctester/test/build/
810

911
# output directories
1012
/cmake/out/

src/ifcopenshell-python/Makefile

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,6 @@ test-parallel:
7979
test-mathutils:
8080
pytest -p no:pytest-blender test/util/test_shape_builder.py
8181

82-
.PHONY: build-ids-docs
83-
build-ids-docs:
84-
mkdir -p test/build
85-
cd test && python ids_doc_generator.py
8682

8783
.PHONY: qa
8884
qa:

src/ifctester/Makefile

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,3 +96,8 @@ webapp-prepare: webapp-build
9696
.PHONY: test
9797
test:
9898
pytest -p no:pytest-blender test
99+
100+
.PHONY: build-ids-docs
101+
build-ids-docs:
102+
mkdir -p test/build
103+
cd test && python ids_doc_generator.py

src/ifctester/test/ids_doc_generator.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,16 @@
1616
# You should have received a copy of the GNU Lesser General Public License
1717
# along with IfcTester. If not, see <http://www.gnu.org/licenses/>.
1818

19+
"""
20+
Documentation generator for IfcTester IDS facets and test cases.
21+
22+
This is not a test file. It lives in the test/ directory because it reuses
23+
test cases from test_facet.py and test_ids.py to generate example IFC files,
24+
IDS files, and Markdown documentation into test/build/.
25+
26+
Run via: make build-ids-docs (from src/ifctester/)
27+
"""
28+
1929
import functools
2030
import os
2131
import re

0 commit comments

Comments
 (0)