Google Git
Sign in
apache / pinot / refs/heads/add-retry-to-download-segment / . / thirdeye / docs
tree: df2a3ca6eaaf887a8379d2419c3624ad0fa9423b [path history] [tgz]
  1. about.rst
  2. advanced_config.rst
  3. alert_setup.rst
  4. appendix.rst
  5. application.rst
  6. basic_config.rst
  7. cache_intro.rst
  8. caches.rst
  9. conf.py
  10. configuration.rst
  11. contribute_datasource.rst
  12. contribute_detection.rst
  13. couchbase.rst
  14. datasources.rst
  15. detection_pipeline_architecture.rst
  16. detection_pipeline_execution_flow.rst
  17. getting_started.rst
  18. import_sql_metric.rst
  19. index.rst
  20. introduction.rst
  21. make.bat
  22. Makefile
  23. mysql.rst
  24. pinot.rst
  25. presto.rst
  26. quick_start.rst
  27. README.md
  28. requirements.txt
  29. setup_cache_datastore.rst
  30. templates.rst
  31. thirdeye_architecture.rst
  32. thirdeye_ui_mocks.rst
thirdeye/docs/README.md

ThirdEye Documentation

This directory contains the documentation for ThirdEye. It is available online at https://thirdeye.readthedocs.io.

Building docs

The documentation is built using the sphinx framework.

If you have python/pip, you can install the dependencies using the command below.

pip3 install -r requirements.txt

Build docs using

make html

The rendered html can be found at _build/html/index.html

Updating docs

  1. Edit or add files as needed.
  2. Build using make livedocs.
  3. Open _build/html/index.html in your favorite browser. The page should auto-update with your changes.
  4. Ensure the contents and links work correctly
  5. Submit a PR!

NOTE: You may see some differences locally as the version of sphinx-build on your local host might not be the same as the one used in readthedocs.io for building the pinot website docs.