docs: fix typos, build docs with gitlab CI

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index aff9bea8d1eb0eed91bafc5bd3b77415d7d472c9..25e4d4f1772207eed6d650b80f7eff7750decd38 100644 (file)
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -92,6 +92,20 @@ build_examples:
     - cd build_examples
     - ${IDF_PATH}/make/build_examples.sh
 
+build_docs:
+  stage: build
+  image: espressif/esp32-ci-env
+  tags:
+    - build_docs
+  script:
+    - cd docs
+    - make html
+  artifacts:
+    paths:
+      - docs/_build/html
+    expire_in: 6 mos
+
+
 test_nvs_on_host:
   stage: test
   image: espressif/esp32-ci-env

diff --git a/docs/eclipse-setup.rst b/docs/eclipse-setup.rst
index 32d60a17a0cad7a496088a25ba00915b18a86411..fbad93be6c4cbf333dd82ea566f5631c53be54e7 100644 (file)
--- a/docs/eclipse-setup.rst
+++ b/docs/eclipse-setup.rst
@@ -1,4 +1,4 @@
-Build and Falsh with Eclipse IDE
+Build and Flash with Eclipse IDE
 ********************************
 
 Installing Eclipse IDE

diff --git a/docs/index.rst b/docs/index.rst
index da03346e7169d201d66a7b81881affb8c54c68ac..c9739506150beeab0c366621b2899caaf26d6f46 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,10 +3,7 @@ ESP32 Programming Guide
 
 .. caution::
 
-   This DRAF version of documentation developed within `ESP-IDF 1.0 Release plan <http://esp32.com/viewtopic.php?f=10&p=1708>`_.
-   It is scheduled for merging with `espressif/esp-idf <https://github.com/espressif/esp-idf>`_ repository at the release date.
-   Before merging it may be incomplete, or not fully in sync with espressif/esp-idf.
-   Please mind your step!
+   Until ESP-IDF release 1.0, this documentation is a draft. It is incomplete and may have mistakes. Please mind your step!
 
 
 Contents:

diff --git a/docs/requirements.txt b/docs/requirements.txt
index 188f51e62deec85b0c9e660685690f6744e50b60..debed28677c65cfe0bf603031f45f7cd2f8b2aad 100644 (file)
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1 +1,6 @@
-breathe
\ No newline at end of file
+# This is a list of python packages used to generate documentation. This file is used with pip:
+# pip install requirements.txt
+#
+sphinx
+sphinx-rtd-theme
+breathe