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.

Sign up for GitHub

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

Jump to bottom

autodoc_default_flags deprecated on a minor version #5421

Closed
vrde opened this issue Sep 13, 2018 · 2 comments
Closed

autodoc_default_flags deprecated on a minor version #5421

vrde opened this issue Sep 13, 2018 · 2 comments
Labels
extensions:autodoc type:bug
Milestone
1.8.1

Comments

@vrde
Copy link

vrde commented Sep 13, 2018

Disclaimer: I assume Sphinx follows the Semantic Versioning rules.

Subject: Sphinx 1.8 is not backward compatible since it deprecates autodoc_default_flags.

Problem

  • Our CI fails to build our documentation, because of:

    sphinx/CHANGES

    Line 149 in efdc95e

    * :confval:`autodoc_default_flags` is deprecated

Procedure to reproduce the problem

I'll skip this section, if you need the commands I can add them later.

Error logs / results

Warning, treated as error:
autodoc_default_flags is now deprecated. Please use autodoc_default_options instead.

Expected results

If Sphinx follows the Semantic Versioning rules, it shouldn't error out if autodoc_default_flags is used. Removing the option is a breaking change and should happen in the next major version of Sphinx (2.0?).

Reproducible project / your project

Environment info

  • OS: GNU/Linux (dunno what they use on Travis-CI, it fails on my Ubuntu 18.04 machine as well)
  • Python version: 3.6
  • Sphinx version: 1.8
vrde added a commit to vrde/bigchaindb that referenced this issue Sep 13, 2018
@vrde
Problem: Sphinx deprecated a config option

Verified

This commit was signed with the committer’s verified signature.
vrde albi.eth
GPG key ID: 6581C7C39B3D397D
Verified
Learn about vigilant mode
8b1afbf 
Solution: Move from `autodoc_default_flags` to
`autodoc_default_options`.

Related issue:
- sphinx-doc/sphinx#5421
@vrde vrde mentioned this issue Sep 13, 2018
Merged
ttmc pushed a commit to bigchaindb/bigchaindb that referenced this issue Sep 13, 2018
@vrde @ttmc
Problem: Sphinx deprecated a config option (#2537)
901b6b9 
Solution: Move from `autodoc_default_flags` to
`autodoc_default_options`.

Related issue:
- sphinx-doc/sphinx#5421
@tk0miya tk0miya added this to the 1.8.1 milestone Sep 13, 2018
@tk0miya
Copy link
Member

tk0miya commented Sep 13, 2018 •
edited
Loading

Thank you for reporting.

We've not adopted to semantic versioning yet. But this warning has not obey to our deprecation rule.
It should be omitted during 1.8.x series.
http://www.sphinx-doc.org/en/master/devguide.html#deprecation-policy

I marked this as a bug and will fix this later.

tk0miya added a commit to tk0miya/sphinx that referenced this issue Sep 13, 2018
@tk0miya
Fix sphinx-doc#5421: autodoc emits deprecation warning for :confval:`…
21d92b4 
…autodoc_default_flags`
@tk0miya tk0miya mentioned this issue Sep 13, 2018
Merged
tk0miya added a commit that referenced this issue Sep 14, 2018
@tk0miya
Merge pull request #5424 from tk0miya/5421_warning_for_autodoc_defaul…

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode
c8b6928 
…t_flags

Fix #5421: autodoc emits deprecation warning for :confval:`autodoc_default_flags`
@tk0miya
Copy link
Member

tk0miya commented Sep 14, 2018

Fixed by #5424.
Thank you for reporting!

@tk0miya tk0miya closed this as completed Sep 14, 2018
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 11, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
extensions:autodoc type:bug
Projects
None yet
Milestone
1.8.1
Development

No branches or pull requests
2 participants
@vrde @tk0miya