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

sphinx-build -M builds into different directory than sphinx-build -b #6896

Closed
dvorapa opened this issue Dec 7, 2019 · 5 comments
Closed

Comments

@dvorapa
Copy link

dvorapa commented Dec 7, 2019

Describe the bug
sphinx-build -M . ./_build builds into ./_build/html, but sphinx-build -b . ./_build builds into ./_build. This is an inconsistency between make html and sphinx-build -b marked as equivalent in https://www.sphinx-doc.org/en/master/usage/quickstart.html.

To Reproduce
Steps to reproduce the behavior:

$ git clone https://github.com/wikimedia/pywikibot
$ cd pywikibot
$ pip install -r requirements.txt .[security] -r docs/requirements-py3.txt
$ cd docs
$ make html
$ sphinx-build -M . ./_build
$ sphinx-build -b . ./_build
compare all three results

make html and sphinx-build -M builds into _build/html, but sphinx-build -b builds into _build

Expected behavior
The build folder should be the same for all three options.

Your project
https://github.com/wikimedia/pywikibot (just a mirror from https://phabricator.wikimedia.org/diffusion/PWBC/)

Environment info

  • OS: Debian Linux
  • Python version: 3.5
  • Sphinx version: 2.2.2
  • Sphinx extensions: autodoc, apidoc, rstcheck, epytext, numpydoc or napoleon, alabaster
wmfgerrit pushed a commit to wikimedia/pywikibot that referenced this issue Dec 7, 2019
Fixes the issue described in
sphinx-doc/sphinx#6896

Change-Id: I6f8e6de4eaef69f699ca7b1d3b5f75cd74593a5a
@tk0miya
Copy link
Member

tk0miya commented Dec 7, 2019

Thank you for reporting. As you mentioned, make-mode (-M) is different with non-make-mode (default). This is intentionally designed behavior. So I'd not like to change this. Anyway, the change will cause incompatibility and troubles.

@dvorapa
Copy link
Author

dvorapa commented Dec 7, 2019

Perhaps this should be mentioned in docs then?

@tk0miya
Copy link
Member

tk0miya commented Dec 7, 2019

You're right. We have to mention about this behavior.

@tk0miya tk0miya reopened this Dec 7, 2019
@introt
Copy link

introt commented Apr 21, 2022

Related: #6603

@AA-Turner
Copy link
Member

Closing in favour of #5618.

A

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 23, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

4 participants