diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..ddf74d82 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,26 @@ +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version, and other tools you might need +build: + os: ubuntu-24.04 + tools: + python: "3.13" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/source/conf.py + +# Optionally, but recommended, +# declare the Python requirements required to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - method: pip + path: . + extra_requirements: + - docs + \ No newline at end of file diff --git a/doc/Makefile b/docs/Makefile similarity index 100% rename from doc/Makefile rename to docs/Makefile diff --git a/doc/make.bat b/docs/make.bat similarity index 100% rename from doc/make.bat rename to docs/make.bat diff --git a/doc/source/calculation.rst b/docs/source/calculation.rst similarity index 100% rename from doc/source/calculation.rst rename to docs/source/calculation.rst diff --git a/doc/source/conf.py b/docs/source/conf.py similarity index 100% rename from doc/source/conf.py rename to docs/source/conf.py diff --git a/doc/source/element_node_interaction.rst b/docs/source/element_node_interaction.rst similarity index 100% rename from doc/source/element_node_interaction.rst rename to docs/source/element_node_interaction.rst diff --git a/doc/source/elements.rst b/docs/source/elements.rst similarity index 100% rename from doc/source/elements.rst rename to docs/source/elements.rst diff --git a/doc/source/examples.rst b/docs/source/examples.rst similarity index 100% rename from doc/source/examples.rst rename to docs/source/examples.rst diff --git a/doc/source/getting_started.rst b/docs/source/getting_started.rst similarity index 100% rename from doc/source/getting_started.rst rename to docs/source/getting_started.rst diff --git a/doc/source/img/elements/add_element.png b/docs/source/img/elements/add_element.png similarity index 100% rename from doc/source/img/elements/add_element.png rename to docs/source/img/elements/add_element.png diff --git a/doc/source/img/elements/add_multiple_elements.png b/docs/source/img/elements/add_multiple_elements.png similarity index 100% rename from doc/source/img/elements/add_multiple_elements.png rename to docs/source/img/elements/add_multiple_elements.png diff --git a/doc/source/img/elements/heart.png b/docs/source/img/elements/heart.png similarity index 100% rename from doc/source/img/elements/heart.png rename to docs/source/img/elements/heart.png diff --git a/doc/source/img/examples/tower_bridge_displa.png b/docs/source/img/examples/tower_bridge_displa.png similarity index 100% rename from doc/source/img/examples/tower_bridge_displa.png rename to docs/source/img/examples/tower_bridge_displa.png diff --git a/doc/source/img/examples/tower_bridge_moment.png b/docs/source/img/examples/tower_bridge_moment.png similarity index 100% rename from doc/source/img/examples/tower_bridge_moment.png rename to docs/source/img/examples/tower_bridge_moment.png diff --git a/doc/source/img/examples/tower_bridge_struct.png b/docs/source/img/examples/tower_bridge_struct.png similarity index 100% rename from doc/source/img/examples/tower_bridge_struct.png rename to docs/source/img/examples/tower_bridge_struct.png diff --git a/doc/source/img/examples/truss_axial.png b/docs/source/img/examples/truss_axial.png similarity index 100% rename from doc/source/img/examples/truss_axial.png rename to docs/source/img/examples/truss_axial.png diff --git a/doc/source/img/examples/truss_displa.png b/docs/source/img/examples/truss_displa.png similarity index 100% rename from doc/source/img/examples/truss_displa.png rename to docs/source/img/examples/truss_displa.png diff --git a/doc/source/img/examples/truss_react.png b/docs/source/img/examples/truss_react.png similarity index 100% rename from doc/source/img/examples/truss_react.png rename to docs/source/img/examples/truss_react.png diff --git a/doc/source/img/examples/truss_struct.png b/docs/source/img/examples/truss_struct.png similarity index 100% rename from doc/source/img/examples/truss_struct.png rename to docs/source/img/examples/truss_struct.png diff --git a/doc/source/img/getting_started/axial_force.png b/docs/source/img/getting_started/axial_force.png similarity index 100% rename from doc/source/img/getting_started/axial_force.png rename to docs/source/img/getting_started/axial_force.png diff --git a/doc/source/img/getting_started/deflection.png b/docs/source/img/getting_started/deflection.png similarity index 100% rename from doc/source/img/getting_started/deflection.png rename to docs/source/img/getting_started/deflection.png diff --git a/doc/source/img/getting_started/moment.png b/docs/source/img/getting_started/moment.png similarity index 100% rename from doc/source/img/getting_started/moment.png rename to docs/source/img/getting_started/moment.png diff --git a/doc/source/img/getting_started/reaction.png b/docs/source/img/getting_started/reaction.png similarity index 100% rename from doc/source/img/getting_started/reaction.png rename to docs/source/img/getting_started/reaction.png diff --git a/doc/source/img/getting_started/shear.png b/docs/source/img/getting_started/shear.png similarity index 100% rename from doc/source/img/getting_started/shear.png rename to docs/source/img/getting_started/shear.png diff --git a/doc/source/img/getting_started/structure.png b/docs/source/img/getting_started/structure.png similarity index 100% rename from doc/source/img/getting_started/structure.png rename to docs/source/img/getting_started/structure.png diff --git a/doc/source/img/loadcase/combi.png b/docs/source/img/loadcase/combi.png similarity index 100% rename from doc/source/img/loadcase/combi.png rename to docs/source/img/loadcase/combi.png diff --git a/doc/source/img/loadcase/lc_cables_displa.png b/docs/source/img/loadcase/lc_cables_displa.png similarity index 100% rename from doc/source/img/loadcase/lc_cables_displa.png rename to docs/source/img/loadcase/lc_cables_displa.png diff --git a/doc/source/img/loadcase/lc_cables_structure.png b/docs/source/img/loadcase/lc_cables_structure.png similarity index 100% rename from doc/source/img/loadcase/lc_cables_structure.png rename to docs/source/img/loadcase/lc_cables_structure.png diff --git a/doc/source/img/loadcase/lc_wind_displa.png b/docs/source/img/loadcase/lc_wind_displa.png similarity index 100% rename from doc/source/img/loadcase/lc_wind_displa.png rename to docs/source/img/loadcase/lc_wind_displa.png diff --git a/doc/source/img/loadcase/lc_wind_structure.png b/docs/source/img/loadcase/lc_wind_structure.png similarity index 100% rename from doc/source/img/loadcase/lc_wind_structure.png rename to docs/source/img/loadcase/lc_wind_structure.png diff --git a/doc/source/img/loadcase/lcwind.png b/docs/source/img/loadcase/lcwind.png similarity index 100% rename from doc/source/img/loadcase/lcwind.png rename to docs/source/img/loadcase/lcwind.png diff --git a/doc/source/img/loadcase/structure.png b/docs/source/img/loadcase/structure.png similarity index 100% rename from doc/source/img/loadcase/structure.png rename to docs/source/img/loadcase/structure.png diff --git a/doc/source/img/loads/moment.png b/docs/source/img/loads/moment.png similarity index 100% rename from doc/source/img/loads/moment.png rename to docs/source/img/loads/moment.png diff --git a/doc/source/img/loads/point.png b/docs/source/img/loads/point.png similarity index 100% rename from doc/source/img/loads/point.png rename to docs/source/img/loads/point.png diff --git a/doc/source/img/loads/q-load.png b/docs/source/img/loads/q-load.png similarity index 100% rename from doc/source/img/loads/q-load.png rename to docs/source/img/loads/q-load.png diff --git a/doc/source/img/plotting/my-figure.png b/docs/source/img/plotting/my-figure.png similarity index 100% rename from doc/source/img/plotting/my-figure.png rename to docs/source/img/plotting/my-figure.png diff --git a/doc/source/img/post_processing/bridge.png b/docs/source/img/post_processing/bridge.png similarity index 100% rename from doc/source/img/post_processing/bridge.png rename to docs/source/img/post_processing/bridge.png diff --git a/doc/source/img/post_processing/deflection.png b/docs/source/img/post_processing/deflection.png similarity index 100% rename from doc/source/img/post_processing/deflection.png rename to docs/source/img/post_processing/deflection.png diff --git a/doc/source/img/post_processing/displacements.png b/docs/source/img/post_processing/displacements.png similarity index 100% rename from doc/source/img/post_processing/displacements.png rename to docs/source/img/post_processing/displacements.png diff --git a/doc/source/img/supports/fixed.png b/docs/source/img/supports/fixed.png similarity index 100% rename from doc/source/img/supports/fixed.png rename to docs/source/img/supports/fixed.png diff --git a/doc/source/img/supports/hinged.png b/docs/source/img/supports/hinged.png similarity index 100% rename from doc/source/img/supports/hinged.png rename to docs/source/img/supports/hinged.png diff --git a/doc/source/img/supports/roll.png b/docs/source/img/supports/roll.png similarity index 100% rename from doc/source/img/supports/roll.png rename to docs/source/img/supports/roll.png diff --git a/doc/source/img/supports/spring.png b/docs/source/img/supports/spring.png similarity index 100% rename from doc/source/img/supports/spring.png rename to docs/source/img/supports/spring.png diff --git a/doc/source/img/vertex/triangle.png b/docs/source/img/vertex/triangle.png similarity index 100% rename from doc/source/img/vertex/triangle.png rename to docs/source/img/vertex/triangle.png diff --git a/doc/source/index.rst b/docs/source/index.rst similarity index 100% rename from doc/source/index.rst rename to docs/source/index.rst diff --git a/doc/source/installation.rst b/docs/source/installation.rst similarity index 100% rename from doc/source/installation.rst rename to docs/source/installation.rst diff --git a/doc/source/loadcases.rst b/docs/source/loadcases.rst similarity index 100% rename from doc/source/loadcases.rst rename to docs/source/loadcases.rst diff --git a/doc/source/loads.rst b/docs/source/loads.rst similarity index 100% rename from doc/source/loads.rst rename to docs/source/loads.rst diff --git a/doc/source/modelling_methods.rst b/docs/source/modelling_methods.rst similarity index 100% rename from doc/source/modelling_methods.rst rename to docs/source/modelling_methods.rst diff --git a/doc/source/plotting.rst b/docs/source/plotting.rst similarity index 100% rename from doc/source/plotting.rst rename to docs/source/plotting.rst diff --git a/doc/source/post_processing.rst b/docs/source/post_processing.rst similarity index 100% rename from doc/source/post_processing.rst rename to docs/source/post_processing.rst diff --git a/doc/source/saving.rst b/docs/source/saving.rst similarity index 100% rename from doc/source/saving.rst rename to docs/source/saving.rst diff --git a/doc/source/supports.rst b/docs/source/supports.rst similarity index 100% rename from doc/source/supports.rst rename to docs/source/supports.rst diff --git a/doc/source/vertex.rst b/docs/source/vertex.rst similarity index 100% rename from doc/source/vertex.rst rename to docs/source/vertex.rst