]> granicus.if.org Git - esp-idf/commitdiff
Docs folder info, ref. https://github.com/espressif/esp-idf/issues/243; Doc title fix
authorkrzychb <krzychb@gazeta.pl>
Tue, 17 Jan 2017 19:37:27 +0000 (20:37 +0100)
committerkrzychb <krzychb@gazeta.pl>
Tue, 17 Jan 2017 19:37:27 +0000 (20:37 +0100)
docs/README.md [new file with mode: 0644]
docs/conf.py

diff --git a/docs/README.md b/docs/README.md
new file mode 100644 (file)
index 0000000..475ce09
--- /dev/null
@@ -0,0 +1,11 @@
+# Documentation Source Folder\r
+\r
+This folder contains source files of [ESP-IDF documentation](http://esp-idf.readthedocs.io/).\r
+\r
+The sources do not render well in GitHub and some information is not visible at all.\r
+\r
+Use actual documentation generated instantly on each commit:\r
+\r
+* Main server: http://esp-idf.readthedocs.io/ or http://esp-idf.rtfd.io/\r
+* Mirror: https://dl.espressif.com/doc/esp-idf/latest/\r
+\r
index 551cd86dd02a93e47021a3f711adf575d935c18a..d38d3dee9d3aaa6e1bdbc4686ec9783e400f7fee 100644 (file)
@@ -65,8 +65,8 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-project = u'ESP32 Programming Guide'
-copyright = u'2016, Espressif'
+project = u'ESP-IDF Programming Guide'
+copyright = u'2016 - 2017, Espressif'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the