From 37b2bd37f7a96a3c9303628599dabcfbfbd00cac Mon Sep 17 00:00:00 2001 From: gutow Date: Fri, 5 Jul 2024 10:59:05 -0500 Subject: [PATCH] Doc updates for 1.0.2 --- Development Notes.md | 12 +- ReadMe.md | 2 +- docs/algebra_with_sympy.html | 86 +- .../algebraic_equation.html | 1416 +++++++++-------- docs/algebra_with_sympy/preparser.html | 72 +- docs/algebra_with_sympy/version.html | 7 +- docs/search.js | 2 +- 7 files changed, 840 insertions(+), 757 deletions(-) diff --git a/Development Notes.md b/Development Notes.md index 1c2f5e0..63d1305 100644 --- a/Development Notes.md +++ b/Development Notes.md @@ -23,10 +23,13 @@ install -U pdoc`. 2. Update any `.md` files included in `_init_.py`. * Generally URLs should be absolute, not relative. -3. At the root level run pdoc `pdoc ---logo https://gutow.github.io/Algebra_with_Sympy/alg_w_sympy.svg +3. At the root level run pdoc +` +pdoc --logo https://gutow.github.io/Algebra_with_Sympy/alg_w_sympy.svg --logo-link https://gutow.github.io/Algebra_with_Sympy/ ---footer-text "Algebra with Sympy vX.X.X" --math -html -o docs algebra_with_sympy` +--footer-text "Algebra with Sympy vX.X.X" --math -html -o docs + ./algebra_with_sympy +` where `X.X.X` is the version number. ### Tasks for Documentation @@ -51,6 +54,9 @@ You can run all the tests using the dotests script: `./dotests.sh`. +**NOTE**: Some warnings about invalid escape characters are expected because +raw strings are being passed with specialized LaTex escaped characters. + ## Building PyPi package 1. Make sure to update the version number in setup.py first. diff --git a/ReadMe.md b/ReadMe.md index 563ecf0..2c2f9ad 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -271,4 +271,4 @@ This program is free software: you can redistribute it and/or modify MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. -Copyright - Algebra with Sympy Contributors 2021, 2022, 2023 \ No newline at end of file +Copyright - Algebra with Sympy Contributors 2021, 2022, 2023, 2024 \ No newline at end of file diff --git a/docs/algebra_with_sympy.html b/docs/algebra_with_sympy.html index 9200631..2fed7bb 100644 --- a/docs/algebra_with_sympy.html +++ b/docs/algebra_with_sympy.html @@ -3,7 +3,7 @@ - + algebra_with_sympy API documentation @@ -18,7 +18,6 @@ } }; - - - -