Uploaded image for project: 'SystemDS'
  1. SystemDS
  2. SYSTEMDS-1825

Use sphinx to generate versioned Python MLContext docs

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Major
    • Resolution: Fixed
    • None
    • SystemML 0.15
    • APIs, Documentation
    • None
    • Sprint 4

    Description

      Currently we generate javadocs for SystemML releases (example: http://systemml.apache.org/docs/0.14.0/api/java/index.html) but we don't generate Python documentation.

      We could use Sphinx to generate documentation for the Python MLContext API and include it in our documentation for SystemML releases.

      Spark does something similar.
      See:
      https://github.com/apache/spark/pull/2292
      https://github.com/apache/spark/pull/2689

      Attachments

        Issue Links

          relates to

          Documentation - Documentation or Website SYSTEMDS-1860 Add pythondoc generation steps to release-process document

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Closed

          Activity

            People

              gweidner Glenn Weidner
              deron Jon Deron Eriksson
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: