WARNING: document isn't included in any toctree for included file

后端 未结 4 1207
故里飘歌
故里飘歌 2020-12-25 09:29

I\'m getting the warning:

WARNING: document isn\'t included in any toctree

for files that exist in the document because they\'ve been expli

4条回答
  •  星月不相逢
    2020-12-25 10:02

    I had a situation where I couldn't edit the documents I wanted to be brought in as a git submodule. The documents already had their own structure including TOC page written in Markdown and I did want them to be processed by sphinx for consistency of formatting.

    What I found I could do is specify a hidden toctree to make toctree aware of the documents, but not clutter up the toctree or add a bunch of errors to my sphinx build output.

    * :doc:`Additional Book `
    
    .. toctree::
       :hidden:
    
       external/documentA.md
       external/documentB.md
    

提交回复
热议问题