Enable js docs, disable failing c docs

.github/workflows/pages.yml

@@ -11,7 +11,17 @@ jobs:
       with:
         submodules: true
 
-    - run: sudo apt-get install -y python3-clang python3-pip libclang-dev clang
+    - name: Use Node.js 22
+      uses: actions/setup-node@v3
+      with:
+        node-version: 22
+        cache: 'npm'
+        cache-dependency-path: 'javascript/package-lock.json'
+
+    # - run: sudo apt-get install -y python3-clang python3-pip libclang-dev clang
+
+    - name: Install JavaScript dependencies
+      run: make jsdependencies && npm install -g jsdoc
 
     - uses: ammaraskar/sphinx-action@master
       with:

docs/conf.py

@@ -31,12 +31,12 @@
     'sphinx.ext.inheritance_diagram',
     'sphinx.ext.mathjax',
     'sphinx.ext.todo',
-    'hawkmoth',
+    # 'hawkmoth',
     # 'breathe',
     # 'javasphinx',
     # 'sphinx_autodoc_typehints',
-    # 'sphinx_pyreverse',
-    # 'sphinx_js',
+    'sphinx_pyreverse',
+    'sphinx_js',
     # 'sphinx_csharp',
 ]
 
@@ -55,7 +55,3 @@
 # https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration
 
 todo_include_todos = True
-
-if 'GITHUB_WORKSPACE' in os.environ:
-    from clang import cindex
-    cindex.Config.set_library_file('/usr/lib/llvm-14/lib/libclang.so.1')

docs/javascript.rst

@@ -11,4 +11,5 @@ Problems Solved
 .. toctree::
    :maxdepth: 1
 
-..    javascript/p0001.rst
+   javascript/p0001.rst
+   javascript/p0002.rst

docs/javascript/p0001.rst

@@ -3,4 +3,4 @@ JavaScript Implementation of Problem 1
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/javascript/p0001.js>`_
 
-.. autojs:: ../javascript/p0001.js
+.. js:autofunction:: p0001

docs/javascript/p0002.rst

@@ -0,0 +1,6 @@
+JavaScript Implementation of Problem 2
+======================================
+
+View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/javascript/p0002.js>`_
+
+.. js:autofunction:: p0002

javascript/p0000_template.js

@@ -1,13 +1,13 @@
-/*
-Project Euler Template
-
-This template is used to format Project Euler solution scripts. This paragraph
-should be replaced by a description of how I approached the problem, as well as
-critque.
-
-This paragraph should be replaced by the problem description, excluding images.
-*/
-
-exports.main = function() {
+/**
+ * Project Euler Template
+ * 
+ * This template is used to format Project Euler solution scripts. This paragraph
+ * should be replaced by a description of how I approached the problem, as well as
+ * critque.
+ * 
+ * This paragraph should be replaced by the problem description, excluding images.
+ **/
+
+exports.p0000 = function() {
 
 };

javascript/p0001.js

@@ -1,17 +1,16 @@
-/*
-Project Euler Problem 1
-
-Did this the old fashioned way, because this was before I figured out the closed form solution
-
-Problem:
-
-If we list all the natural numbers below 10 that are multiples of 3 or 5, we
-get 3, 5, 6 and 9. The sum of these multiples is 23.
-
-Find the sum of all the multiples of 3 or 5 below 1000.
+/**
+* Project Euler Problem 1
+* 
+* Did this the old fashioned way, because this was before I figured out the closed form solution
+* 
+* Problem:
+* 
+* If we list all the natural numbers below 10 that are multiples of 3 or 5, we
+* get 3, 5, 6 and 9. The sum of these multiples is 23.
+* 
+* Find the sum of all the multiples of 3 or 5 below 1000.
 */
-
-exports.main = function() {
+exports.p0001 = function() {
     let answer = 0;
     for (let i = 3; i < 1000; i += 3) {
         answer += i;

javascript/p0002.js

@@ -1,20 +1,19 @@
-/*
-Project Euler Problem 2
-
-Moved the fibonacci optimization to javascript
-
-Problem:
-
-Each new term in the Fibonacci sequence is generated by adding the previous two
-terms. By starting with 1 and 2, the first 10 terms will be:
-
-1, 2, 3, 5, 8, 13, 21, 34, 55, 89, ...
-
-By considering the terms in the Fibonacci sequence whose values do not exceed
-four million, find the sum of the even-valued terms.
-*/
-
-exports.main = function() {
+/**
+ * Project Euler Problem 2
+ * 
+ * Moved the fibonacci optimization to javascript
+ * 
+ * Problem:
+ * 
+ * Each new term in the Fibonacci sequence is generated by adding the previous two
+ * terms. By starting with 1 and 2, the first 10 terms will be:
+ * 
+ * 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, ...
+ * 
+ * By considering the terms in the Fibonacci sequence whose values do not exceed
+ * four million, find the sum of the even-valued terms.
+ **/
+exports.p0002 = function() {
 // for a proof on why this formulation works, see python/p0002.py
     let answer = 0;
     let i = 2;

javascript/test.js

@@ -18,7 +18,7 @@ for (question in answers) {
                 if (knownSlow.includes(question)) {
                     this.timeout(-1);
                 }
-                assert.equal(answer, module.main());
+                assert.equal(answer, module[`p${formattedQuestion}`]());
             });
             it('should return take less than 1 minute', function(done) {
                 this.timeout(-1);