Moodle Community Sites

Automatically build the generated docs from XMLDB and make them available to the pubic

Details

  • Type: New Feature New Feature
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Deferred
  • Component/s: moodle.org
  • Labels:
    None

Description

Save the attached generate_all_docs.php script into admin/xmldb/actions/generate_documentation on your moodle site (2.0 dev only), then visit the .../admin/xmldb/actions/generate_documentation/generate_all_docs.php URL in your browser.

You will find that this builds a set of HTML pages in moodledata/dbdocs/. These are entirely self-contained HTML files and can be copied anywhere else.

I suggest we set this up to run automatically once per day (or at the same time as the unmerged files check), and add the generated contents somewhere public. How about in a subdirectory on http://phpdocs.moodle.org/, with a link on that site's front page.

Issue Links

Activity

Hide
Eloy Lafuente (stronk7) added a comment -

Hi,

in MDL-19307 I've implemented one big report containing all the docs from DB (plus some improvements I've done to the xsl sheet). Not sure if you'll want to use that report to generate the public information or no, as you decide, just FYI.

Ciao

Show
Eloy Lafuente (stronk7) added a comment - Hi, in MDL-19307 I've implemented one big report containing all the docs from DB (plus some improvements I've done to the xsl sheet). Not sure if you'll want to use that report to generate the public information or no, as you decide, just FYI. Ciao

People

Vote (0)
Watch (1)

Dates

  • Created:
    Updated:
    Resolved: