Skip to content

Backport Sphinx 1.6 support to PyScaffold 2.5 #152

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
Closed
FlorianWilhelm opened this issue Mar 20, 2018 · 7 comments
Closed

Backport Sphinx 1.6 support to PyScaffold 2.5 #152

FlorianWilhelm opened this issue Mar 20, 2018 · 7 comments
Labels
help wanted Extra attention is needed and contributors are encouraged to participate

Comments

@FlorianWilhelm
Copy link
Member

Right now PyScaffold 2.5.x can only handle Sphinx up to version 1.5 since there was an API change. PyScaffold 3 was changed accordingly and this change could be also back-ported to PyScaffold 2.5.x.
@FlorianWilhelm FlorianWilhelm added the help wanted Extra attention is needed and contributors are encouraged to participate label Mar 20, 2018
@cpaulik
Copy link
Contributor

cpaulik commented Apr 4, 2018

Is that the reason for an error like:

python setup.py docs
running build_sphinx
usage: usage: setup.py [OPTIONS] -o <OUTPUT_PATH> <MODULE_PATH> [EXCLUDE_PATTERN, ...]
setup.py: error: unrecognized arguments: setup.py

?

@FlorianWilhelm
Copy link
Member Author

@cpaulik Yes, exactly. You can double check by downgrading Sphinx to version 1.5.

@cpaulik
Copy link
Contributor

cpaulik commented Apr 4, 2018

It works with sphinx 1.5. If you can point me to the changes that were necessary for Pyscaffold 3 then I will take a look at Pyscaffold 2.5.x. Maybe I can whip up a PR.

@FlorianWilhelm
Copy link
Member Author

Thanks, it should be in file https://github.com/blue-yonder/pyscaffold/blob/14358522f4ad4c5c38a5290f8885a86bbbeb12c6/src/pyscaffold/templates/sphinx_conf.template#L44-L57 where sphinx-apidoc is called.

cpaulik added a commit to cpaulik/pyscaffold that referenced this issue Apr 11, 2018
@cpaulik
Fix build_sphinx command for sphinx>1.5
5499547 
The new apidoc command does not take the executable as a first argument.

It also takes the excludes as a positional argument after the module directory.

Fixes pyscaffold#152
@cpaulik cpaulik mentioned this issue Apr 11, 2018
Closed
@FlorianWilhelm
Copy link
Member Author

@cpaulik I added some commits to v2.x that updated pbr to version 4.0.2. It seems to work now, could you also check if it works for you?

@FlorianWilhelm
Copy link
Member Author

@cpaulik, v2.5.11 was just released which fixes this issue.

@cpaulik
Copy link
Contributor

cpaulik commented Apr 18, 2018

Thanks. Works perfectly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted Extra attention is needed and contributors are encouraged to participate
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@cpaulik @FlorianWilhelm