Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WebSupport places pickles outside specified datadir #55

Open
liborjelinek opened this issue Dec 11, 2017 · 0 comments
Open

WebSupport places pickles outside specified datadir #55

liborjelinek opened this issue Dec 11, 2017 · 0 comments

Comments

@liborjelinek
Copy link

liborjelinek commented Dec 11, 2017

WebSupport class offers to specify buildir and datadir params (plus some others). Builddir param is optional (have default value ''). If you don't buildir but specify datadir, then files made during Sphinx build (pickles/ folder, files like environment.pickle or globalcontext.pickle) are not placed in specified <datadir> but in <current_work_dir>/data.

At sphinxcontrib.websupport in core.py:55 is introduced self.outdir

54   self.builddir = builddir
55   self.outdir = path.join(builddir, 'data')
56   self.datadir = datadir or self.outdir

that has only usage: it's passed to Sphinx constructor at core.py:125

125  app = Sphinx(self.srcdir, self.srcdir, self.outdir, self.doctreedir,
                  'websupport', status=self.status, warning=self.warning)

Proposed fix: IMHO outdir at core.py:55 line should look like this:

self.outdir = datadir or os.path.join(builddir, 'data')
@AA-Turner AA-Turner transferred this issue from sphinx-doc/sphinx Sep 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant