From 67cc79d1eb86a6f15cd284c7ed1f288e068a1206 Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Thu, 30 Apr 2020 14:42:33 -0700 Subject: [PATCH 1/4] Create README for sphinx docs --- docs/README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..04a9b0497 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,19 @@ +Getting Started +--------------- + +### Installing documentation requirements + +To install dependescies required to generate sphinx documentation locally, execute the following command from the main directory: + + pip install -r requirements/docs.txt + +### Building documentation locally + +To generate python SDK documentation locally, execure the following command: + + cd docs/ + make html + +This will build HTML docs in `docs/build` directory. To open documentation, simply run: + + open build/html/index.html \ No newline at end of file From ec285532f7cd4d544bd8e7663b8c3c3277ba6442 Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Thu, 30 Apr 2020 14:45:17 -0700 Subject: [PATCH 2/4] Fix spelling --- docs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index 04a9b0497..60141365b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,13 +3,13 @@ Getting Started ### Installing documentation requirements -To install dependescies required to generate sphinx documentation locally, execute the following command from the main directory: +To install dependencies required to generate sphinx documentation locally, execute the following command from the main directory: pip install -r requirements/docs.txt ### Building documentation locally -To generate python SDK documentation locally, execure the following command: +To generate python SDK documentation locally, execute the following command: cd docs/ make html From 80801f4c0b8de9562b247bae8197f9aa3c2c56e8 Mon Sep 17 00:00:00 2001 From: Polina Nguen <43302774+yavorona@users.noreply.github.com> Date: Thu, 30 Apr 2020 17:58:28 -0700 Subject: [PATCH 3/4] Update README.md Add title --- docs/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 60141365b..d5534dcb1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,6 @@ +Optimizely Python SDK Sphinx Documentation +===================== + Getting Started --------------- @@ -16,4 +19,4 @@ To generate python SDK documentation locally, execute the following command: This will build HTML docs in `docs/build` directory. To open documentation, simply run: - open build/html/index.html \ No newline at end of file + open build/html/index.html From 7dc3dfa8f945d15e2e2877916e4df474ff532530 Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Tue, 5 May 2020 17:10:33 -0700 Subject: [PATCH 4/4] Incorporate Ali's comments --- docs/README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/README.md b/docs/README.md index d5534dcb1..2c5032fbd 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,10 +1,10 @@ -Optimizely Python SDK Sphinx Documentation -===================== +Documentation +============= Getting Started --------------- -### Installing documentation requirements +### Installing the requirements To install dependencies required to generate sphinx documentation locally, execute the following command from the main directory: @@ -12,11 +12,9 @@ To install dependencies required to generate sphinx documentation locally, execu ### Building documentation locally -To generate python SDK documentation locally, execute the following command: +To generate Python SDK documentation locally, execute the following commands: cd docs/ make html -This will build HTML docs in `docs/build` directory. To open documentation, simply run: - - open build/html/index.html +This will build HTML docs in `docs/build/html/index.html`. Open this file in your web browser to see the docs. \ No newline at end of file