Skip to content

Commit

Permalink
readthedocs fixes to topology inheritance diagram, add mixin classes …
Browse files Browse the repository at this point in the history
…to `topology/__init__.py`, delete docs/requirements.txt, streamline workflows
  • Loading branch information
jdegenstein committed Jan 15, 2025
1 parent 338e0bc commit d78ca93
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 17 deletions.
3 changes: 1 addition & 2 deletions .github/actions/setup/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,4 @@ runs:
- name: Install Requirements
shell: bash
run: |
pip install wheel mypy pytest pytest-cov pylint
pip install .
pip install .[development]
4 changes: 3 additions & 1 deletion docs/direct_api_reference.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

####################
Direct API Reference
####################
Expand Down Expand Up @@ -52,7 +53,7 @@ supplementary functionality specific to 1D
`~topology.Solid`) objects respectively.
Note that a :class:`~topology.Compound` may be contain only 1D, 2D (:class:`~topology.Face`) or 3D objects.

.. inheritance-diagram:: topology
.. inheritance-diagram:: topology.shape_core topology.zero_d topology.one_d topology.two_d topology.three_d topology.composite topology.utils
:parts: 1

.. py:module:: topology
Expand All @@ -63,6 +64,7 @@ Note that a :class:`~topology.Compound` may be contain only 1D, 2D (:class:`~top
:special-members: __neg__
.. autoclass:: Mixin1D
:special-members: __matmul__, __mod__
.. autoclass:: Mixin2D
.. autoclass:: Mixin3D
.. autoclass:: Shape
:special-members: __add__, __sub__, __and__, __rmul__, __eq__, __copy__, __deepcopy__, __hash__
Expand Down
11 changes: 0 additions & 11 deletions docs/requirements.txt

This file was deleted.

6 changes: 3 additions & 3 deletions src/build123d/topology/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@
find_max_dimension,
)
from .zero_d import Vertex, topo_explore_common_vertex
from .one_d import Edge, Wire, edges_to_wires, topo_explore_connected_edges
from .two_d import Face, Shell, sort_wires_by_build_order
from .three_d import Solid
from .one_d import Edge, Wire, Mixin1D, edges_to_wires, topo_explore_connected_edges
from .two_d import Face, Shell, Mixin2D,sort_wires_by_build_order
from .three_d import Solid, Mixin3D
from .composite import Compound, Curve, Sketch, Part

__all__ = [
Expand Down

0 comments on commit d78ca93

Please sign in to comment.