From 46d8ece20e5e48fd0f0abeccd62fc62284f92d35 Mon Sep 17 00:00:00 2001 From: krzychb Date: Tue, 17 Jan 2017 20:37:27 +0100 Subject: [PATCH] Docs folder info, ref. https://github.com/espressif/esp-idf/issues/243; Doc title fix --- docs/README.md | 11 +++++++++++ docs/conf.py | 4 ++-- 2 files changed, 13 insertions(+), 2 deletions(-) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000000..475ce0973e --- /dev/null +++ b/docs/README.md @@ -0,0 +1,11 @@ +# Documentation Source Folder + +This folder contains source files of [ESP-IDF documentation](http://esp-idf.readthedocs.io/). + +The sources do not render well in GitHub and some information is not visible at all. + +Use actual documentation generated instantly on each commit: + +* Main server: http://esp-idf.readthedocs.io/ or http://esp-idf.rtfd.io/ +* Mirror: https://dl.espressif.com/doc/esp-idf/latest/ + diff --git a/docs/conf.py b/docs/conf.py index 551cd86dd0..d38d3dee9d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 -- 2.40.0