cleanup docs and outdated examples and other experiments and

Krande · Nov 26, 2024 · 6b38b28 · 6b38b28
1 parent a1915c2
commit 6b38b28
Show file tree

Hide file tree

Showing 142 changed files with 243 additions and 10,054 deletions.
diff --git a/.github/workflows/ci-pages.yml b/.github/workflows/ci-pages.yml
@@ -16,14 +16,17 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0 # otherwise, you will fail to push refs to dest repo
+
       - uses: mamba-org/setup-micromamba@v2 # https://github.com/mamba-org/setup-micromamba
         with:
           activate-environment: adadocs
           python-version: "3.11"
           environment-file: docs/environment.docs.yml
+
       - name: Build and Commit
         run: |
           cd docs && make html
+
       - name: Upload to GitHub Pages
         uses: peaceiris/actions-gh-pages@v4
         with:

diff --git a/conda/conda_build_config.yaml b/conda/conda_build_config.yaml
diff --git a/conda/environment.build.yml b/conda/environment.build.yml
diff --git a/conda/environment.full.yml b/conda/environment.full.yml
diff --git a/conda/meta.yaml b/conda/meta.yaml
diff --git a/docs/conf.py b/docs/conf.py
@@ -6,7 +6,7 @@
 html_title = "ADA - Assembly for Design & Analysis"
 author = "Kristoffer H. Andersen"
 copyright = f"{datetime.datetime.now().year}, {author}"
-release = "0.1.0"
+release = "0.3.5"
 
 
 # -- General configuration ---------------------------------------------------
@@ -15,6 +15,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = ["sphinx.ext.autodoc", "myst_parser"]
+myst_enable_extensions = ["colon_fence"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

diff --git a/docs/documents/code.rst b/docs/documents/code.rst
@@ -5,199 +5,5 @@ ADA
 -----------------------------------
 The main library.
 
-
-.. automodule:: ada.api.spatial
-   :members:
-
-.. automodule:: ada.api.primitives
-   :members:
-
-.. automodule:: ada.api.beams
-   :members:
-
-.. automodule:: ada.api.plates
-   :members:
-
-.. automodule:: ada.api.containers
-   :members:
-
-.. automodule:: ada.base.root
-   :members:
-
-.. automodule:: ada.base.physical_objects
-   :members:
-
-
-
-IFC utilities
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-`IFC4X1 <https://standards.buildingsmart.org/IFC/RELEASE/IFC4_1/FINAL/HTML/link/annex-e.htm>`_
-
-.. automodule:: ada.cadit.ifc
-   :members:
-
-Blender wrapper and utilities
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-`Blender <https://www.blender.org/>`_
-
-.. automodule:: ada.core.blender
-   :members:
-
-
-Bimserver utilities
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-`BimServer <https://github.com/opensourceBIM/BIMserver>`_
-
-.. automodule:: ada.core.bimserver
-   :members:
-
-
-Other
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. automodule:: ada.core.constants
-   :members:
-
-
-
-.. automodule:: ada.core.utils
-   :members:
-
-
-
-FEM (Finite Element Method)
------------------------------
-A shared class structure for describing finite element models and analysis
-
-Main
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. automodule:: ada.fem
-   :members:
-
-
-FEM Containers
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. automodule:: ada.fem.containers
-   :members:
-
-
-Utils
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. automodule:: ada.fem.utils
-   :members:
-
-
-IO
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-All code related to interoperability for Finite Element Method (FEM)
-
-Code Aster
-~~~~~~~~~~~~~~~~
-`Code Aster <https://www.code-aster.org>`_ is an Open Source FEM solver
-
-.. automodule:: ada.fem.formats.code_aster
-   :members:
-
-GMSH
-~~~~~~~~~~~~~~~~
-`GMSH <https://gmsh.info/>`_ is a three-dimensional finite element mesh generator with built-in pre- and
-post-processing facilities
-
-.. automodule:: ada.fem.meshing
-   :members:
-
-Abaqus
-~~~~~~~~~~~~~~~~
-`Abaqus <https://www.3ds.com/products-services/simulia/products/abaqus/>`_ is a Proprietary Finite Element suite
-(pre/post processor and solver)
-
-.. automodule:: ada.fem.formats.abaqus
-   :members:
-
-
-Calculix
-~~~~~~~~~~~~~~~~
-`Calculix <http://www.calculix.de/>`_ is an Open Source (GNU General Public License V2 or later) FEM solver
-
-.. automodule:: ada.fem.formats.calculix
-   :members:
-
-Sesam
-~~~~~~~~~~~~~~~~
-`Sesam By DnvGL <https://www.dnvgl.com/services/offshore-and-marine-structural-engineering-sesam-for-fixed-structures-1096>`_
-is a proprietary finite element suite (pre/post processor and solver)
-
-
-.. automodule:: ada.fem.formats.sesam
-   :members:
-
-
-Usfos
-~~~~~~~~~~~~~~~~
-`USFOS <https://usfos.no/>`_ is a proprietary finite element solver
-
-
-
-.. automodule:: ada.fem.formats.usfos
-   :members:
-
-
-Utilities
-~~~~~~~~~~~~~~~~
-A collection of python utilities and different Python Wrappers for Various FEM software (Abaqus, Femap, GMSH).
-
-.. automodule:: ada.fem.formats.utils
-   :members:
-
-
-Materials
------------------------------
-A collection of different utilities for material properties. Future use-case would be that this library contains
-a library of structural material properties that have been properly defined and accepted by all locations.
-
-
-Metals
-^^^^^^^^^^^^^^^^
-
-.. automodule:: ada.materials.metals
-    :members:
-
-
-Polymers
-^^^^^^^^^^^^^^^^
-
-.. automodule:: ada.materials.polymers
-    :members:
-
-.. automodule:: ada.materials.polymers.models
-    :members:
-
-.. automodule:: ada.materials.polymers.utils
-    :members:
-
-Sections
------------------------------------
-
-.. automodule:: ada.sections
-   :members:
-
-.. automodule:: ada.sections.utils
-   :members:
-
-Base Classes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. automodule:: ada.base
-   :members:
-
-Visualization Classes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. automodule:: ada.visit.concept
-   :members:
+.. automodule:: ada
+   :members:
diff --git a/docs/documents/config.rst b/docs/documents/config.rst