Commit Graph

7 Commits

Author SHA1 Message Date
Fabio Utzig 77b5937562 doc: update known-issues for Sphinx==3.3.0
Sphinx==3.3.0 slightly changed the warning messages, which causes fails
on filter-known-issues. Update to the new messages.

Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
2020-11-03 15:27:37 +01:00
Fabio Utzig c2b567f79e doc: update known issues for Sphinx>=3.2.0
Remove old known issues files and update with issues that still need to
be fixed in Sphinx>=3.2.0 and or Doxygen, including anonymous
union/struct parsing and duplicated symbols (eg struct and functions
having the same name).

Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
2020-08-31 09:57:33 -04:00
Kumar Gala 5fb312b784 doc: Update warning regex to handler newer sphinx output
Older versions of sphinx produced something like:

file_system/index.rst:58: WARNING: Duplicate declaration.

Newer versions produce:

file_system/index.rst:58: WARNING: Duplicate declaration, fs_statvfs

Change the regex to handle both conditions.

Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2019-12-12 12:39:35 -06:00
Anas Nashif d6f72a67fc doc: introduce final structure
Move guides and APIs into separate directories and cleanup naming
introducing index files rather than named section files.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-05 07:04:40 -05:00
Anas Nashif 4db3d06c2e doc: add peripherals reference
Create a reference page for each peripheral and move doxygen API
reference to the main documentation page.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-01-30 18:38:48 -05:00
Carles Cufi 5e5fe0d74f doc: known issues: Fix regexes for Windows
Fix the regexes in the known issues database so that they work on
Winndows machines with different path formats.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-07-12 23:11:46 -04:00
David B. Kinder ef75956deb doc: update known-issues filter
New versions of Sphinx/Breathe are throwing a new  warning that
we'll need to filter before upgrading to breathe 4.9.1 and sphinx 1.7.5

This change won't impact our current builds but will prevent new known
warning messages when we upgrade the doc build tools.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-06-13 21:02:24 -04:00