Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Is doctrees folder required for displaying html docs with Sphinx?

When hosting docs built with Sphinx, the build folder has two subdirectories: doctrees and html. Do I need both folders to display the docs correctly or only the contents of the html folder?

If I do need both, do the contents of the html folder go into my public_html folder and doctrees at the same level (outside the publicly accessible portion of my webserver, maintaining the current relative path relationship) or something else?

I can't find the answer in documentation for Sphinx.

like image 327
Dan Avatar asked Nov 24 '15 21:11

Dan


People also ask

What does Sphinx-build do?

sphinx-build can create documentation in different formats. A format is selected by specifying the builder name on the command line; it defaults to HTML. Builders can also perform other tasks related to documentation processing. For a list of available builders, refer to sphinx-build -b .


1 Answers

The doctrees (or .doctrees) folder contains pickled caches of the source *.rst documents and it is not needed to display the docs correctly. You only need the contents of the html folder for that.

See http://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-d.

like image 51
mzjn Avatar answered Sep 21 '22 04:09

mzjn