export documentation

The code is a JavaScript part of a larger project that manages and exports notebooks and functions, with the exportAll function being the main entry point. It generates an index page and a search page, but several TODO comments indicate areas that need to be implemented or improved.

Run example

What the code could have been:

// Import required modules
const fs = require('fs');
const path = require('path');
const importer = require('./importer'); // assuming importer module is in the same directory
const Remarkable = require('remarkable');
const md = new Remarkable({ html: true, xhtmlOut: true, breaks: true });

// Define constants
const PROJECT_PATH = path.resolve(path.join(path.dirname(__dirname), 'docs'));
const TEMPLATE_PATH = path.resolve(__dirname, 'templates');
const LANGUAGE_TEMPLATE_FILE = 'highlight.js';
const JAVADOC_TEMPLATE_FILE = 'javadoc-template.js';
const CACHE_FUNCTIONS_FILE = 'cache-rpc-functions-with-llm-descriptions.js';

// Define template variables
const languageTemplate = importer.interpret(LANGUAGE_TEMPLATE_FILE);
const javadocTemplate = importer.interpret(JAVADOC_TEMPLATE_FILE);

// Define cache variables
const cacheFunctions = importer.import(CACHE_FUNCTIONS_FILE);

// Define function to export all notebooks
async function exportAll() {
  // Create project directory if it doesn't exist
  if (!fs.existsSync(PROJECT_PATH)) {
    fs.mkdirSync(PROJECT_PATH);
  }

  // Get list of all notebooks
  const notebooks = await listInProject(path.resolve(__dirname, '../'), '{,*,*/,*/*/*,*/*/*/*}*.ipynb');

  // Initialize variables to store results
  const results = {};

  // Loop through each notebook
  for (const notebook of notebooks) {
    // Get namespace and category from notebook path
    const relative = path.relative(path.resolve(__dirname, '../'), notebook);
    const category = relative.split(path.sep)[0];
    const namespace = path.basename(notebook).replace('.ipynb', '');

    // Create category directory if it doesn't exist
    if (!fs.existsSync(path.join(PROJECT_PATH, category))) {
      fs.mkdirSync(path.join(PROJECT_PATH, category));
    }

    // Create index page for category
    const categoryIndex = path.join(PROJECT_PATH, category, 'index.html');
    results[categoryIndex] = {
      output: '',
      indexOutput: '',
      title: category,
      next: '',
      prev: '',
    };
    results[categoryIndex].index = categoryIndex;
    results[categoryIndex].output += '' + category + '\n\n';
    results[categoryIndex].link = '' + category + '';

    // Loop through each cell in notebook
    for (const cell of cacheCells(notebook)) {
      // Create cell index page
      const cellIndex = path.join(path.join(PROJECT_PATH, category, namespace), 'index.html');
      results[cellIndex] = {
        output: '',
        indexOutput: '',
        title: cell.questions[0],
        next: '',
        prev: '',
      };
      results[cellIndex].index = cellIndex;
      results[cellIndex].parent = '' + namespace + '';
      results[cellIndex].output += '' + cell.questions[0] + '\n\n';

      // Add cell to category index
      results[categoryIndex].output += '' + cell.questions[0] + '\n\n';

      // Create cell HTML page
      const cellHtml = path.join(path.join(PROJECT_PATH, category, namespace), safeurl(cell.questions[0]) + '.html');
      results[cellHtml] = {
        output: '',
        indexOutput: '',
        title: cell.questions[0],
        next: '',
        prev: '',
      };
      results[cellHtml].index = cellIndex;
      results[cellHtml].parent = '' + namespace + '';
      results[cellHtml].output += '' + cell.questions[0] + '\n\n';

      // Add cell to search results
      results[categoryIndex].output += '' + cell.questions[0] + '\n\n';

      // Render HTML page
      results[cellHtml].output = languageTemplate.code.replaceAll('${LANGUAGE}', cell.language) + '\n\n';
      if (cell.questions[0]) {
        results[cellHtml].output = 'Run example
\n\nnpm run import -- "' + cell.questions[0] + '"' + results[cellHtml].output;
      }
      results[cellHtml].output += md.render(cell.description);
      fs.writeFileSync(cellHtml, results[cellHtml].output);
    }
  }

  // Export all HTML pages
  const pathList = Object.keys(results);
  for (const path of pathList) {
    const relative = path.relative(path.resolve(__dirname, '../docs'), path);
    const template = importer.interpret('mergehtml.js');
    const output = template.code
     .replaceAll('${TITLE}', results[path].title)
     .replaceAll('${PARENT}', results[path].parent)
     .replaceAll('${NEXT}', results[path].next)
     .replaceAll('${PREV}', results[path].prev)
     .replaceAll('${OUTPUT}', results[path].output)
     .replaceAll('${SEARCH}', 'Search');
    fs.writeFileSync(path, output);
  }
}

// Call exportAll function
exportAll();

The code is written in JavaScript and appears to be a part of a larger project that manages and exports notebooks and functions.

Import Statements

The code starts with a series of import statements that bring in various functions and modules from other parts of the project. These imports include:

Constants and Variables

exportAll Function

The exportAll function is an asynchronous function that appears to be the main entry point of the code. It takes a query parameter that is not used anywhere in the function.

TODO Comments

The code contains several TODO comments that indicate areas that need to be implemented or improved. These include:

Overall Structure

The code appears to be a part of a larger project that manages and exports notebooks and functions. The exportAll function is the main entry point, and it sets up some variables and generates an index page and a search page. The code also contains several TODO comments that indicate areas that need to be implemented or improved.

Run example

export documentation

What the code could have been:

' + category + '

' + cell.questions[0] + '

' + cell.questions[0] + '

Run example

Import Statements

Constants and Variables

exportAll Function

TODO Comments

Overall Structure

`exportAll` Function