From 3bc4958b04def66c92467997af98c5af01c6e3be Mon Sep 17 00:00:00 2001 From: Tim Diller Date: Wed, 22 Oct 2025 11:30:22 -0500 Subject: [PATCH] documentation for fancymath --- doc/Makefile | 20 ++++++++++++++++++++ doc/conf.py | 28 ++++++++++++++++++++++++++++ doc/index.rst | 18 ++++++++++++++++++ doc/intro.rst | 24 ++++++++++++++++++++++++ doc/make.bat | 35 +++++++++++++++++++++++++++++++++++ src/fancymath/util.py | 14 ++++++++++++++ src/fancymath/vector.py | 32 ++++++++++++++++++++++++++++++++ 7 files changed, 171 insertions(+) create mode 100644 doc/Makefile create mode 100644 doc/conf.py create mode 100644 doc/index.rst create mode 100644 doc/intro.rst create mode 100644 doc/make.bat create mode 100644 src/fancymath/util.py create mode 100644 src/fancymath/vector.py diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000..3bd544f --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,28 @@ +# 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 + +project = 'fancymath' +copyright = '2025, Diller Digital' +author = 'Diller Digital' +release = '0.0.1' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"] + +templates_path = ['_templates'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.ipynb_checkpoints'] + + + +# -- 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'] diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000..a4d2f49 --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,18 @@ +.. fancymath documentation master file, created by + sphinx-quickstart on Wed Oct 22 11:18:42 2025. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +fancymath documentation +======================= + +Add your content using ``reStructuredText`` syntax. See the +`reStructuredText `_ +documentation for details. + + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + intro \ No newline at end of file diff --git a/doc/intro.rst b/doc/intro.rst new file mode 100644 index 0000000..0a47a19 --- /dev/null +++ b/doc/intro.rst @@ -0,0 +1,24 @@ +Introduction +============ +Fancymath package includes vector operations in a simple implementation +of a 3D vector class. + +Example +------- + +The following Python session shows examples of +the use of the Vector class:: + + >>> from fancymath.vector import Vector + >>> u = Vector(1, 2, 0.5) + >>> print(u) + Vector(x=1, y=2, z=0.5) + >>> u.abs() + 2.29128784747792 + >>> v = Vector(0, 1, 2) + >>> u.dot(v) + 3.0 + >>> u.angle(v) + 0.945250237728822 + +See the reference documentation for more details. \ No newline at end of file diff --git a/doc/make.bat b/doc/make.bat new file mode 100644 index 0000000..954237b --- /dev/null +++ b/doc/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/src/fancymath/util.py b/src/fancymath/util.py new file mode 100644 index 0000000..cb4fa56 --- /dev/null +++ b/src/fancymath/util.py @@ -0,0 +1,14 @@ +""" +Some utilities for working with Vector instances. +""" + +from vectorlib.vector import Vector + + +def print_vectors(veclist): + """Print a list of vectors. + + *veclist* must be a list of Vector instances. + """ + for vec in veclist: + print(vec) diff --git a/src/fancymath/vector.py b/src/fancymath/vector.py new file mode 100644 index 0000000..baf5a2f --- /dev/null +++ b/src/fancymath/vector.py @@ -0,0 +1,32 @@ +"""This module defines the Vector class. """ + +from math import acos, sqrt + + +class Vector(object): + def __init__(self, x, y, z): + """Constructor method.""" + self.x = x + self.y = y + self.z = z + + def dot(self, v): + """Returns the dot product with Vector *v*.""" + d = self.x * v.x + self.y * v.y + self.z * v.z + return d + + def abs(self): + """Returns the magnitude of the vector.""" + m = sqrt(self.x**2 + self.y**2 + self.z**2) + return m + + def __repr__(self): + s = "Vector(x=%s, y=%s, z=%s)" % (self.x, self.y, self.z) + return s + + +if __name__ == "__main__": + v1 = Vector(2.0, 13.0, -1.0) + print(v1, " magnitude is", v1.abs()) + v2 = Vector(1.0, 2.0, 3.0) + print("v1.dot(v2) =", v1.dot(v2))