readthedocs fixes to topology inheritance diagram, add mixin classes to topology/__init__.py, delete docs/requirements.txt, streamline workflows

This commit is contained in:
jdegenstein 2025-01-15 12:46:19 -06:00
parent 338e0bc0bf
commit d78ca933fc
4 changed files with 7 additions and 17 deletions

View file

@ -14,5 +14,4 @@ runs:
- name: Install Requirements
shell: bash
run: |
pip install wheel mypy pytest pytest-cov pylint
pip install .
pip install .[development]

View file

@ -1,3 +1,4 @@
####################
Direct API Reference
####################
@ -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
@ -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__

View file

@ -1,11 +0,0 @@
# TODO: delete this file as it is no longer used to build the docs
# Defining the exact version will make sure things don't break
sphinx==5.3.0
sphinx_rtd_theme>=0.5.1
docutils<0.17
readthedocs-sphinx-search>=0.3.2
sphinx_autodoc_typehints==1.12.0
sphinx_copybutton
sphinx-hoverxref
sphinx_design
-e git+https://github.com/gumyr/build123d.git#egg=build123d

View file

@ -51,9 +51,9 @@ from .utils import (
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__ = [