mirrors/build123d
1
Fork 0
mirror of https://github.com/gumyr/build123d.git synced 2025-12-06 02:30:55 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

Docs improvements

Browse source
This commit is contained in:
Roger Maitland 2022-07-15 11:20:24 -04:00
parent cf5f140d02
commit 014100da1a
4 changed files with 11 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -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).

4
docs/conf.py
View file

@ -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"

2
docs/environment.yaml
View file

@ -7,4 +7,4 @@ dependencies:
- nbsphinx
- pip:
- sphinx_rtd_theme
- git+https://github.com/gumyr/cq_warehouse.git#egg=cq_warehouse
- git+https://github.com/gumyr/build123d.git#egg=build123d

6
docs/index.rst
View file

@ -26,8 +26,10 @@
.. highlight:: python
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.
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