Google Git
Sign in
apache / systemds / refs/heads/gh-pages
commit415f99f7969d1690f6266cc16b923e0dc3fe3a22[log] [tgz]
authorJanardhan Pulivarthi <j143@protonmail.com>Wed Apr 08 18:00:33 2020 +0530
committerJanardhan Pulivarthi <j143@protonmail.com>Tue Apr 14 00:08:49 2020 +0530
tree2d15922b2503598876e093d4376690a9e74d8d88
parent82d73bd8c715a3c8e436543a6c6d5db14cb9b1bb [diff]
[MINOR][DOC] Skip IntelliJ, mvn config & build files in git

  - mvn files
  - intellij IDEA project files

Closes #880.
1 file changed
tree: 2d15922b2503598876e093d4376690a9e74d8d88
  1. _layouts/
  2. alg-ref/
  3. css/
  4. devdocs/
  5. files/
  6. img/
  7. js/
  8. lang-ref/
  9. .gitignore
  10. _config.yml
  11. algorithms-bibliography.md
  12. algorithms-classification.md
  13. algorithms-clustering.md
  14. algorithms-descriptive-statistics.md
  15. algorithms-factorization-machines.md
  16. algorithms-matrix-factorization.md
  17. algorithms-reference.md
  18. algorithms-regression.md
  19. algorithms-survival-analysis.md
  20. beginners-guide-caffe2dml.md
  21. beginners-guide-keras2dml.md
  22. beginners-guide-python.md
  23. beginners-guide-to-dml-and-pydml.md
  24. contributing-to-systemds.md
  25. debugger-guide.md
  26. deep-learning.md
  27. developer-tools-systemds.md
  28. dml-language-reference.md
  29. engine-dev-guide.md
  30. Gemfile
  31. gpu.md
  32. hadoop-batch-mode.md
  33. index.md
  34. jmlc.md
  35. native-backend.md
  36. python-performance-test.md
  37. python-reference.md
  38. README.md
  39. reference-guide-caffe2dml.md
  40. reference-guide-keras2dml.md
  41. release-creation-process.md
  42. release-process.md
  43. spark-batch-mode.md
  44. spark-mlcontext-programming-guide.md
  45. standalone-guide.md
  46. troubleshooting-guide.md
README.md

Apache SystemDS Documentation

The primary SystemDS documentation is written in markdown (*.md) and can be converted to HTML using Jekyll.

Ubuntu Install

  1. Install Ruby development environment Jekyll on Ubuntu.

  2. Install Jekyll inside the Ruby environment.

    • gem install jekyll jekyll-redirect-from bundler pygments.rb
    • To do this you might need to change permissions on folders /var/lib/gems and /var/lib/gems/2.5.0.
    • The Pygments package is optional, and does require sudo permissions.

  3. Install python dependencies (Optionally).

    • pip install Pygments

  4. Launch the Documentation locally

    • jekyll serve -w
    • This is done from the root of the gh-pages branch of the system.
    • The serving will per default be on localhost port 4000 Link

Mac Install

Jekyll (and optionally Pygments) can be installed on the Mac OS in the following manner.

brew install ruby
gem install jekyll
gem install jekyll-redirect-from
gem install bundler
brew install python
pip install Pygments
gem install pygments.rb

To generate SystemDS documentation in HTML, navigate to the docs folder, the root directory of the documentation. From there, you can have Jekyll convert the markdown files to HTML. If you run in server mode, Jekyll will serve up the generated documentation by default at http://127.0.0.1:4000. Modifications to *.md files will be converted to HTML and can be viewed in a web browser.

jekyll serve -w