This is an automated email from the ASF dual-hosted git repository.
kishoreg pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-pinot.git
The following commit(s) were added to refs/heads/master by this push:
new 07938ea [TE] Updated README in ThirdEye Documentation (#5678)
07938ea is described below
commit 07938eae1357e3908ce624677728d555ed95a126
Author: Suvodeep Pyne <suvodeep-p...@users.noreply.github.com>
AuthorDate: Fri Jul 10 11:09:55 2020 -0700
[TE] Updated README in ThirdEye Documentation (#5678)
Changes
- Added links to install sphinx which is required to build the docs
- Refactored the readme and added some useful links
Co-authored-by: Suvodeep Pyne <suvodeep.p...@realia.in>
---
thirdeye/docs/README.md | 31 ++++++++++++++++++++++++++-----
1 file changed, 26 insertions(+), 5 deletions(-)
diff --git a/thirdeye/docs/README.md b/thirdeye/docs/README.md
index 5f23fcc..3e7fcc4 100644
--- a/thirdeye/docs/README.md
+++ b/thirdeye/docs/README.md
@@ -19,10 +19,31 @@
-->
-Updating the docs:
+# 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](https://www.sphinx-doc.org/)
framework.
+
+If you have python/pip, you can install sphinx using
+```
+pip install sphinx sphinx_rtd_theme
+```
+
+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. Run "make html"
-3. Open _build/html/index.html in your favorite browser and ensure contents
and links work correctly.
+2. Build using `make html`
+3. Open `_build/html/index.html` in your favorite browser
+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.
\ No newline at end of file
+> 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](https://readthedocs.io) for building the pinot website docs.
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org
For additional commands, e-mail: commits-h...@pinot.apache.org
