add files for the init build

docs/conf.py

@@ -0,0 +1,51 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../amworkflow"))
+
+project = "amworkflow"
+copyright = "2024, Annika Robens-Radermacher, Yuxiang He"
+author = "Annika Robens-Radermacher, Yuxiang He"
+release = "1.0"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "myst_parser",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.githubpages",
+]
+
+myst_enable_extensions = [
+    "dollarmath",
+    "amsmath",
+]
+
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+# html_theme = 'alabaster'
+html_static_path = ["_static"]
+
+html_theme = "sphinx_rtd_theme"
+
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".md": "markdown",
+}

docs/index.md

@@ -0,0 +1,37 @@
+# AMworkflow
+
+# Dev on Documentation
++ Prerequisite: ```Sphinx```, ```sphinx-autobuild```, ```sphinx-rtd-theme```, ```sphinxcontrib-applehelp```, ```sphinxcontrib-devhelp```, ```sphinxcontrib-htmlhelp```, ```sphinxcontrib-jquery```, ```sphinxcontrib-jsmath```, ```sphinxcontrib-qthelp```, ```sphinxcontrib-serializinghtml```.
++ How does it work?
+Use the command:
+
+```sphinx-autobuild . _build/html```
+
+The server should be ready on Localhost Port 8000 and it auto builds when changes made.
+
+
+## Introduction
+Some Intro
+
+## Project Organization
+Some info about organization
+
+## BuiltinCAD
+
+### Shortest_distance_point_line
+![Small dist line point](pics/Pasted-Graphic.png)
+The function returns the shortest distance between a point and a line (segment). For example in figure above the result will be $(d_{min},\frac{L_1}{L_1+L_2})$.
+
+```{eval-rst}
+.. autofunction:: amworkflow.geometry.builtinCAD.shortest_distance_point_line
+```
+
+
+```{math}
+e^{i\pi} + 1 = 0
+```
+
+```{eval-rst}
+.. automodule:: amworkflow.geometry.builtinCAD
+   :members: CreateWallByPoints
+```