Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/.custom_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ GitHub
Sphinx
URL
PR
PRs
Read the Docs
Spread
landscape
Expand Down
27 changes: 27 additions & 0 deletions docs/how-to/troubleshooting/build-errors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,30 @@ To fix the issue, try:
* Restricting problem packages to recent versions (using ``package~=version``)
* Using a constraints file

Sporadic "No such file or directory" errors
-------------------------------------------

If your Read the Docs builds are sporadically failing due to a file missing error,
first check the build output to make sure the issue isn't related to dependencies.

Once you have verified this is not the case, double check your ``conf.py`` configuration.

Probable cause
~~~~~~~~~~~~~~~

The ``sphinx-llm`` extension by default creates a parallel process that touches build files while the main process
(or other extensions, like ``sphinx-tags``) could still be using them. This can cause the missing
file error.

Resolution
~~~~~~~~~~

.. warning::
Note that this workaround can cause your build times to grow, as the parallel nature of the normal config cuts build times considerably.

To fix this, tell ``sphinx-llm`` in your ``conf.py`` to not build in parallel:

.. code-block:: python

# Run sphinx-llm markdown generation sequentially to prevent race conditions
llms_txt_build_parallel = False
Loading