Commit 727f92c5 authored by David B. Kinder's avatar David B. Kinder Committed by Anas Nashif
Browse files

doc: update 1.9 release with RTD theme 



We've replaced the "zephyr-docs" theme with a simpler read-the-docs
theme starting with the 1.13 release. This PR retrofits the theme
changes back onto this 1.9 release and ignores attempts to use the
zephyr-docs theme controlled by the make DOC_TAGS option.

Also needed to backport changes to the warning filtering system
implemented in later releases, fixes to how the config options were
generated (genrest.py).

Signed-off-by: default avatarDavid B. Kinder <david.b.kinder@intel.com>
parent 14457984

.known-issues/doc/duplicate.conf

0 → 100644
+6 −0
Original line number Diff line number Diff line 
#

^(?P<filename>([-:\\/\w\.])+[/\\]doc[/\\]api[/\\]file_system.rst):(?P<lineno>[0-9]+): WARNING: Duplicate declaration.

#

^(?P<filename>([-:\\/\w\.])+[/\\]doc[/\\]api[/\\]io_interfaces.rst):(?P<lineno>[0-9]+): WARNING: Duplicate declaration.

#

^(?P<filename>([-:\\/\w\.])+[/\\]doc[/\\]subsystems[/\\]sensor.rst):(?P<lineno>[0-9]+): WARNING: Duplicate declaration.

.known-issues/doc/networking.conf

+2 −2
Original line number Diff line number Diff line
@@ -20,12 +20,12 @@ 
# include/net/net_if.h warnings

#

^(?P<filename>[-._/\w]+/doc/api/networking.rst):(?P<lineno>[0-9]+): WARNING: Error when parsing function declaration.

^\If the function has no return type:

^If the function has no return type:

^[ \t]*Error in declarator or parameters and qualifiers

^[ \t]*Invalid definition: Expected identifier in nested name, got keyword: struct \[error at [0-9]+]

^.*struct net_if __aligned\(32\)

^[- \t]*\^

^\If the function has a return type:

^If the function has a return type:

^[ \t]*Error in declarator or parameters and qualifiers

^[ \t]*If pointer to member declarator:

^[ \t]*Invalid definition: Expected \'::\' in pointer to member \(function\). \[error at [0-9]+]

boards/xtensa/esp32/doc/esp32.rst

+1 −2
Original line number Diff line number Diff line
@@ -15,7 +15,7 @@ From Wikipedia: 
   Tensilica Xtensa LX6 microprocessor in both dual-core and single-core

   variations.  ESP32 is created and developed by Espressif Systems, a

   Shanghai-based Chinese company, and is manufactured by TSMC using their 40nm

   process. [1]_

   process..



The features include the following:
@@ -171,7 +171,6 @@ for ESP32`_. 
References

**********



.. [1] https://en.wikipedia.org/wiki/ESP32

.. _`ESP32 Technical Reference Manual`: https://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf

.. _`JTAG debugging for ESP32`: https://espressif.com/sites/default/files/documentation/jtag_debugging_for_esp32_en.pdf

.. _`toolchain`: https://esp-idf.readthedocs.io/en/latest/get-started/index.html#get-started-setup-toochain

doc/Makefile

+4 −1
Original line number Diff line number Diff line
@@ -66,6 +66,8 @@ clean: 
	@rm -rf reference/kconfig/*.rst

	@rm -rf samples

	@rm -rf boards

	@rm -f doc.log

	@rm -f doc.warnings



htmldocs: doxy html
@@ -79,7 +81,8 @@ kconfig: scripts/genrest/genrest.py 
prep: doxy content kconfig



html: content kconfig

	$(Q)$(SPHINXBUILD) -t $(DOC_TAG) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

	$(Q)$(SPHINXBUILD) -t $(DOC_TAG) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 2>&1 | tee -a doc.log;

	$(Q)./scripts/filter-doc-log.sh doc.log

	@rm -rf samples

	@rm -rf boards

doc/_templates/breadcrumbs.html

0 → 100644
+14 −0
Original line number Diff line number Diff line 
{% extends "!breadcrumbs.html" %}

{% block breadcrumbs %}

  <!-- {{ docs_title }} -->

  {# parameterize default name "Docs" in breadcrumb via docs_title in conf.py #}

  {% if not docs_title %}

  {% set docs_title = "Docs" %}

  {% endif %}



  <li><a href="{{ pathto(master_doc) }}">{{ docs_title }}</a> &raquo;</li>

  {% for doc in parents %}

     <li><a href="{{ doc.link|e }}">{{ doc.title }}</a> &raquo;</li>

  {% endfor %}

  <li>{{ title }}</li>

{% endblock %}

CRA Git | Maintained and supported by SUSTech CRA and CCSE