diff --git a/README.md b/README.md index df4d5aa..375e7e1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ Build123D is an alternate to the [CadQuery](https://cadquery.readthedocs.io/en/latest/index.html) -Fluent API. It has several advantages over this API but the largest one is that Build123D is more -Pythonic than CadQuery 2.x. making it easier to learn and more functional. +Fluent API. It has several advantages over this API but the largest one is that build123d +enables the full python toolbox when designing objects - for loops, references to objects, +list sorting and filtering, etc. - unconstrained by the limitations of method chaining +used in CadQuery 2.x. The documentation for **build123d** can found at [readthedocs](https://build123d.readthedocs.io/en/latest/index.html). diff --git a/docs/conf.py b/docs/conf.py index 9ac0fd9..45016fd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -14,7 +14,7 @@ import os import sys build123d_path = os.path.dirname(os.path.abspath(os.getcwd())) -source_files_path = os.path.join(build123d_path, "../") +source_files_path = os.path.join(build123d_path, "src", "build123d") sys.path.insert(0, source_files_path) sys.path.append(os.path.abspath("sphinxext")) sys.path.insert(0, os.path.abspath(".")) @@ -22,7 +22,7 @@ sys.path.insert(0, os.path.abspath("../")) # -- Project information ----------------------------------------------------- -project = "Build123D" +project = "build123d" copyright = "2022, Gumyr" author = "Gumyr" diff --git a/docs/environment.yaml b/docs/environment.yaml index 351d8eb..685d57e 100644 --- a/docs/environment.yaml +++ b/docs/environment.yaml @@ -7,4 +7,4 @@ dependencies: - nbsphinx - pip: - sphinx_rtd_theme - - git+https://github.com/gumyr/cq_warehouse.git#egg=cq_warehouse \ No newline at end of file + - git+https://github.com/gumyr/build123d.git#egg=build123d diff --git a/docs/index.rst b/docs/index.rst index 7bc5fae..23880a4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,8 +26,10 @@ .. highlight:: python build123d is an alternate to the `CadQuery `_ -Fluent API. It has several advantages over this API but the largest one is that build123d is more -Pythonic than CadQuery 2.x. +Fluent API. It has several advantages over this API but the largest one is that build123d +enables the full python toolbox when designing objects - for loops, references to objects, +list sorting and filtering, etc. - unconstrained by the limitations of method chaining +used in CadQuery 2.x. ######## Overview