Always use / in toctree (also on Windows)?

[tobiasleibner]

CMinx uses toctree.text(os.path.join(directory, "index.rst")) (here) to insert the the index files in the toctree. On Windows, this results in, e.g.,

#####
Title
#####

.. toctree:: 
   :maxdepth: 2

   subfolder\index.rst
   cmakefile1
   cmakefile2

with a backslash as path separator. When reading this file, Sphinx gives the following warning:

sphinx.errors.SphinxWarning: C:\...\build\win_msvc\docs\Debug\sphinx_src\cmake\index.rst:6:toctree contains reference to nonexisting document 'folder/subfolder\\index'

Replacing the backward by a forward slash, i.e., subfolder/index.rst instead of subfolder\index.rst fixes the problem.

I could not find a definite reference for that but it looks like the paths in the toctree should always use a forward slash?

[ryanmrichard]

I just did a couple searches myself. While I also can't find an authoritative source there seems to be enough issues about needing "/" on Windows to suggest that using os.path.join is wrong. I should have some free time in the next couple hours to try to fix this.