Updated jsdocs.

lurchmath · Jun 17, 2024 · 31b14b1 · 31b14b1
1 parent b4f8b23
commit 31b14b1
Show file tree

Hide file tree

Showing 32 changed files with 193 additions and 6,246 deletions.
diff --git a/docs/CNFProp.html b/docs/CNFProp.html
diff --git a/docs/CNFProp.js.html b/docs/CNFProp.js.html
diff --git a/docs/Extensions.html b/docs/Extensions.html
diff --git a/docs/extensions.js.html b/docs/extensions.js.html
diff --git a/docs/global-validation.js.html b/docs/global-validation.js.html
diff --git a/docs/global.html b/docs/global.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/interpret.js.html b/docs/interpret.js.html
diff --git a/docs/lode.js.html b/docs/lode.js.html
diff --git a/docs/lurch-options.js.html b/docs/lurch-options.js.html
diff --git a/docs/module-GlobalValidation.html b/docs/module-GlobalValidation.html
diff --git a/docs/module-Interpretation.html b/docs/module-Interpretation.html
diff --git a/docs/module-Lode.html b/docs/module-Lode.html
diff --git a/docs/module-MathLive.MathItem.html b/docs/module-MathLive.MathItem.html
diff --git a/docs/module-MathLive.html b/docs/module-MathLive.html
diff --git a/docs/module-Parsing.html b/docs/module-Parsing.html
diff --git a/docs/module-Reporting.html b/docs/module-Reporting.html
diff --git a/docs/module-Utilities.html b/docs/module-Utilities.html
diff --git a/docs/parsing.js.html b/docs/parsing.js.html
diff --git a/docs/reporting.js.html b/docs/reporting.js.html
diff --git a/docs/tutorial-Getting Started Examples.html b/docs/tutorial-Getting Started Examples.html
diff --git a/docs/tutorial-Lurch Node REPL.html b/docs/tutorial-Lurch Node REPL.html
diff --git a/docs/tutorial-Propositional Form.html b/docs/tutorial-Propositional Form.html
diff --git a/docs/utils.js.html b/docs/utils.js.html
diff --git a/docs/utils_math-live.js.html b/docs/utils_math-live.js.html
diff --git a/docs/utils_utilities.js.html b/docs/utils_utilities.js.html
diff --git a/init.js b/init.js
@@ -7,7 +7,7 @@
 process.stdout.write(defaultPen(`Loading proofs ...\n`))
 let start = Date.now()
 ////////////////////////////////////////////////////////////////////////////
-
+//
 // casesdoc = $(
 // `
 // {

diff --git a/jsdoc-conf.json b/jsdoc-conf.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "lde",
+  "name": "lab",
   "version": "0.1.0",
-  "description": "Lurch Deductive Engine (LDE)",
+  "description": "Lurch Validation Tools",
   "type": "module",
   "directories": {
     "doc": "docs",
@@ -17,23 +17,16 @@
     "puppeteer": "^15.1.1",
     "tidy-jsdoc": "^1.4.1"
   },
-  "scripts": {
-    "test": "node src/database/generate.js && node --trace-warnings tests/all-in-puppeteer.js",
-    "docs": "rm -f tutorials/output/*.md && node scripts/pre-docs.js && rm -rf docs && jsdoc src/* -d docs -R doc-main.md -c jsdoc-conf.json -u tutorials/output/ && node scripts/post-docs.js",
-    "build-db": "node src/database/generate.js",
-    "show-docs": "open docs/index.html",
-    "test-server": "node src/database/generate.js && node tests/test-server.cjs"
-  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/lurchmath/lde.git"
+    "url": "git+https://github.com/lurchmath/lab.git"
   },
-  "author": "Nathan Carter (ncarter@bentley.edu)",
+  "author": "Ken Monks (monks@scranton.edu)",
   "license": "LGPL-3.0",
   "bugs": {
-    "url": "https://github.com/lurchmath/lde/issues"
+    "url": "https://github.com/lurchmath/lab/issues"
   },
-  "homepage": "https://github.com/lurchmath/lde#readme",
+  "homepage": "https://github.com/lurchmath/lab#readme",
   "dependencies": {
     "algebrite": "^1.4.0",
     "chalk": "^5.0.1",

diff --git a/src/lode.js b/src/lode.js
@@ -597,7 +597,10 @@ rpl.defineCommand( "makedocs", {
   action() {
     console.log(defaultPen('Building docs...')) 
     try {
-      execStr('rm -rf docs && jsdoc ./* -d docs -c utils/jsdoc-conf.json -u tutorials/ && node utils/post-docs')
+      execStr(
+        `rm -rf ../docs &&
+        jsdoc .. -d ../docs/ -c ../utils/jsdoc-conf.json -u ../tutorials/ && 
+        node ../utils/post-docs`)
       console.log(defaultPen('...done'))
     } catch (err) {
       console.log('Error building docs.')
@@ -610,7 +613,7 @@ rpl.defineCommand( "makedocs", {
 rpl.defineCommand( "showdocs", {
   help: "Open the jsdocs index.html page in the browser.",
   action() { 
-    exec('open docs/index.html')
+    exec('open ../docs/index.html')
     this.displayPrompt()
   }
 })

diff --git a/utils/jsdoc-conf.json b/utils/jsdoc-conf.json
@@ -1,15 +1,16 @@
 {
     "plugins": ["plugins/markdown"],
     "opts": {
-        "_template": "../../node_modules/clean-jsdoc-theme",
-        "template": "../../node_modules/tidy-jsdoc", 
+        "_template": "../node_modules/clean-jsdoc-theme",
+        "template": "../node_modules/tidy-jsdoc", 
         "prism-theme": "prism-default",
         "encoding": "utf8",
         "recurse": true,
         "verbose": false,
         "theme_opts": {
             "default_theme": "dark"
-        }
+        },
+        "readme": "../README.md"
     },
     "markdown": {
         "hardwrap": false,
@@ -28,8 +29,8 @@
     },	
     "source": {
         "exclude": [
-            "./scripts/acidtests.js",
-            "./scripts/post-docs.js"
+            "../utils",
+            "../node_modules"
         ]
     }
 }
diff --git a/utils/lurchmath config/lde-cdn.js b/utils/lurchmath config/lde-cdn.js
@@ -1,18 +1,31 @@
 
 /**
- * This file imports all needed classes from the main branch of the LDE repo.
- * We do it in this file so that anywhere else in the app, it can just load this
+ * This file imports all needed classes from the main branch of the LDE repo. We
+ * do it in this file so that anywhere else in the app, it can just load this
  * file and know it's getting the right classes.  Then if we need to change the
  * URL, we can do it here in one place, rather than in many places throughout
  * the codebase.
  */
 
+// local imports (uncomment to use)
 export {
-    LogicConcept, MathConcept,
-    Environment, Declaration, Expression, LurchSymbol
-} from '../lde/src/index.js' 
-// from 'https://cdn.jsdelivr.net/gh/lurchmath/lde@master/src/index.js'
+  MathConcept, LogicConcept, Expression, Declaration, Environment, LurchSymbol,
+  Matching, Formula, Scoping, Validation, Application
+} from '../../lde/src/index.js' 
+export { Problem } from '../../lde/src/matching/problem.js'
+export { BindingExpression } from '../../lde/src/binding-expression.js'
+export { default } from '../../lde/src/validation/conjunctive-normal-form.js' 
 
-import branchLDE from '../lde/src/experimental/global-validation.js'
-//from 'https://cdn.jsdelivr.net/gh/lurchmath/lde@85e7368b912116420a2dc7475c616a721ec38ba1/src/experimental/global-validation.js'
-export const LDE = branchLDE
+/* From CDN (uncomment to use)
+export {
+  MathConcept, LogicConcept, Expression, Declaration, Environment, LurchSymbol,
+  Matching, Formula, Scoping, Validation, Application
+} from 
+  'https://cdn.jsdelivr.net/gh/lurchmath/lde@master/src/index.js'
+export { Problem } from 
+  'https://cdn.jsdelivr.net/gh/lurchmath/lde@master/src/matching/problem.js'
+export { BindingExpression } from 
+   'https://cdn.jsdelivr.net/gh/lurchmath/lde@master/src/binding-expression.js'
+export { default } from 
+  'https://cdn.jsdelivr.net/gh/lurchmath/lde@master/src/validation/conjunctive-normal-form.js'
+*/