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

1.6.1 incorrectly warns about dedent with literalinclude #3755

Closed
dhermes opened this issue May 16, 2017 · 4 comments
Closed

1.6.1 incorrectly warns about dedent with literalinclude #3755

dhermes opened this issue May 16, 2017 · 4 comments

Comments

@dhermes
Copy link

dhermes commented May 16, 2017

Problem

Our build fails when running sphinx-build with the -W flag. An example would be

  .. literalinclude:: logging_snippets.py
     :start-after: [START client_create_default]
     :end-before: [END client_create_default]
     :dedent: 4

and viewing the actually included source, one can see that 4 space dedent is correct. (FWIW I tried 1-space dedent and it also failed.)

Procedure to reproduce the problem

sphinx-build -W -b html -d docs/_build/doctrees docs/ docs/_build/html/

Error logs / results

Warning, treated as error:
/var/code/gcp/docs/logging-usage.rst.rst:25:Over dedent has detected

Expected results

The build should succeed.

Reproducible project / your project

Environment info

  • OS: Ubuntu (not sure which version our docker image uses)
  • Python version: 3.6
  • Sphinx version: 1.6.1
@tk0miya
Copy link
Member

tk0miya commented May 18, 2017

Thank you for reporting and sorry for inconvenience.
Fixed at dabd356.

@tk0miya tk0miya closed this as completed May 18, 2017
@dhermes
Copy link
Author

dhermes commented May 18, 2017

Thanks @tk0miya. Would you like me to install from HEAD to verify or to wait until a release?

@tk0miya
Copy link
Member

tk0miya commented May 18, 2017

I confirmed it works well at local. But it would be nice if you also confirm this.
Anyway, we will release next bug-fixed version soon. So it's okay to wait it.

@dhermes
Copy link
Author

dhermes commented May 18, 2017

Just confirmed via:

pip install git+https://github.com/sphinx-doc/sphinx/

See build.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 26, 2021
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

2 participants