I have an open PR to add MX6625UW1G45G SPI NOR flash MTD driver which includes an added Documentation/components/drivers/special/mtd/mx66uw1g45g.rst file based on mx25l/r .rst files found there.  In my local tree I can "make html" and see the added doco page, but in the PR it fails (as seen starting on line 551 of https://github.com/apache/nuttx/actions/runs/37860648845/job/113595293483?pr=20521) with:

checking consistency... failed Warning, treated as error: /home/runner/work/nuttx/nuttx/Documentation/components/drivers/special/mtd/devices/mx66uw1g45g.rst:document isn't included in any toctree make: *** [Makefile:52: html] Error 2 Error: Process completed with exit code 2.

Documentation/components/drivers/special/mtd/index.rst contains:

.. toctree::
  :maxdepth: 1
  :glob:

  devices/*

Which I believe should cause reference to all the MTD device .rst files including my added mx66uw1g45g.rst.

Any idea why generating  documentation fails in my PR  with "document isn't included in any toctree" but builds locally?

Thanks in advance!

--
Peter Barada
[email protected]

Reply via email to