Details

    • MOODLE_24_STABLE
    • MOODLE_26_STABLE
    • Hide

      You'll need to install yuidocjs from npm:

      npm install yuidocjs -g
      

      Now run yuidoc:

      cd git/moodle
      yuidoc
      

      • check your built documentation in ../yuidocs

      The documentation should be built for all those modules with enough documentation.
      There are lots of errors as the docs are built, but this can be improved.

      Show
      You'll need to install yuidocjs from npm: npm install yuidocjs -g Now run yuidoc: cd git/moodle yuidoc check your built documentation in ../yuidocs The documentation should be built for all those modules with enough documentation. There are lots of errors as the docs are built, but this can be improved.

    Description

      The YUIDoc configuration can go in a file named 'yuidoc.json' anywhere within the Moodle tree, but not in a parent directory. It can documentation can be built outside of the working tree.

      Here's a sample configuration I've been using based on the core YUI configuration:

      {
          "name": "Moodle",
          "description": "YUI documentation for Moodle",
          "url": "https://moodle.org",
          "logo": "https://moodle.org/theme/image.php/moodleofficial/theme/1360919562/moodle-logo",
          "options": {
              "external": {
                  "data": "http://yuilibrary.com/yui/docs/api/data.json"
              },
              "linkNatives": true,
              "attributesEmit": "true",
              "selleck": "true",
              "outdir": "../yuidocs",
              "paths": "**/yui/src/*"
          }
      }
      

      Attachments

        Activity

          People

            dobedobedoh Andrew Lyons
            dobedobedoh Andrew Lyons
            Dan Poltawski Dan Poltawski
            Sam Hemelryk Sam Hemelryk
            Sam Hemelryk Sam Hemelryk
            Andrew Lyons, Huong Nguyen, Jun Pataleta, Michael Hawkins, Shamim Rezaie, Simey Lameze, Stevani Andolo
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:
              18/Nov/13