Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ include:
Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or
advances
advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
address, without explicit permission
address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting
professional setting

## Our Responsibilities

Expand Down
5 changes: 3 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ jobs:
- name: Generate documentation
uses: compas-dev/compas-actions.docs@v5
with:
doc_url: https://gramaziokohler.github.io/compas_cadwork
github_token: ${{ secrets.GITHUB_TOKEN }}
python: '3.12'
use_conda: false
generator: mkdocs
extras: mkdocs
test_docs: false
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,9 @@ ENV/
# Rope project settings
.ropeproject

# PyCharm project settings
.idea/

# mkdocs documentation
/site

Expand Down
2 changes: 2 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ repos:
rev: v6.0.0
hooks:
- id: check-yaml
args: [--unsafe] # For mkdocs.yml
- id: check-toml
- id: check-case-conflict
- id: check-merge-conflict
Expand All @@ -33,6 +34,7 @@ repos:
- mdformat-gfm-alerts
- mdformat-ruff
- mdformat-tables
- mdformat-mkdocs
args: [--number]

- repo: https://github.com/astral-sh/uv-pre-commit
Expand Down
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- Switched project to Astral's uv project manager.
- Deprecated `compas_cadwork.storage`, `compas_cadwork.datamodel`, `compas_cadwork.scene`, and `compas_cadwork.utilities`.
- Migrated documentation from Sphinx to MkDocs

### Removed

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2024 Gramazio Kohler Research, ETH Zurich
Copyright (c) 2024-present Gramazio Kohler Research, ETH Zurich

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@
[![Twitter Follow](https://img.shields.io/twitter/follow/compas_dev?style=social)](https://twitter.com/compas_dev)
[![Made with COMPAS](https://compas.dev/badge.svg)](https://compas.dev/)

![COMPAS Cadwork](https://raw.githubusercontent.com/gramaziokohler/compas_cadwork/refs/heads/main/compas_cadwork.jpg)
![COMPAS Cadwork](https://raw.githubusercontent.com/gramaziokohler/compas_cadwork/refs/heads/main/docs/assets/images/dome.jpg)

COMPAS cadwork is an open-source Python package which allows you to harness the power of the COMPAS framework inside cadwork 3d.
Make use of COMPAS' extensive geometry kernel, data structures, and algorithms to create, manipulate, and analyze your 3d models in cadwork.
Gain access to the COMPAS ecosystem which includes a wide range of tools and libraries engineered for the AEC industry.

## Installation

> For the different installation options please see the [installation guide](https://gramaziokohler.github.io/compas_cadwork/latest/installation.html).
> For the different installation options please see the [complete documentation](https://gramaziokohler.github.io/compas_cadwork/).

To install `compas_cadwork` directly to cadwork 3d, run:

Expand Down
1 change: 0 additions & 1 deletion data/stand_w_drills.json

This file was deleted.

Binary file removed docs/_images/element_dimension.JPG
Binary file not shown.
Binary file removed docs/_images/half_dome.JPG
Binary file not shown.
Binary file removed docs/_images/half_dome_texture.JPG
Binary file not shown.
Binary file removed docs/_images/half_dome_viewer.JPG
Binary file not shown.
1 change: 0 additions & 1 deletion docs/_static/PLACEHOLDER

This file was deleted.

11 changes: 0 additions & 11 deletions docs/api.rst

This file was deleted.

1 change: 1 addition & 0 deletions docs/api/compas_cadwork.conversions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# ::: compas_cadwork.conversions
17 changes: 0 additions & 17 deletions docs/api/compas_cadwork.conversions.rst

This file was deleted.

1 change: 1 addition & 0 deletions docs/api/compas_cadwork.datamodel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# ::: compas_cadwork.datamodel
19 changes: 0 additions & 19 deletions docs/api/compas_cadwork.datamodel.rst

This file was deleted.

1 change: 1 addition & 0 deletions docs/api/compas_cadwork.elements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# ::: compas_cadwork.elements
1 change: 1 addition & 0 deletions docs/api/compas_cadwork.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# ::: compas_cadwork
1 change: 1 addition & 0 deletions docs/api/compas_cadwork.scene.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# ::: compas_cadwork.scene
17 changes: 0 additions & 17 deletions docs/api/compas_cadwork.scene.rst

This file was deleted.

1 change: 1 addition & 0 deletions docs/api/compas_cadwork.utilities.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# ::: compas_cadwork.utilities
47 changes: 0 additions & 47 deletions docs/api/compas_cadwork.utilities.rst

This file was deleted.

Binary file added docs/assets/images/beams-showcase.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
Binary file added docs/assets/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/panels-showcase.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/assets/stylesheets/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
:root > * {
--md-primary-fg-color: #0092d2;
}
166 changes: 0 additions & 166 deletions docs/conf.py

This file was deleted.

10 changes: 0 additions & 10 deletions docs/examples.rst

This file was deleted.

Loading