Skip to content

Fix build_docs build path #5156

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
Merged
eteq merged 1 commit into from
Jul 6, 2016
Merged

Fix build_docs build path #5156

eteq merged 1 commit into from
Jul 6, 2016

Conversation

@adrn
Copy link
Member

@adrn adrn commented Jul 5, 2016

This adds a new section to setup.cfg for build_docs so that

python setup.py build_sphinx

and

python setup.py build_docs

build to the same location: <root>/docs/_build/.... Testing locally, this seems to be all it took. Not sure if this should be tested in some way -- thoughts?

Also, I'm not sold that we need two documentation build commands that do the same exact thing, but that can be discussed elsewhere...(I guess I should take it up with robo-Erik?)

Closes #4133

cc @eteq @astrofrog

@eteq
Copy link
Member

eteq commented Jul 5, 2016 •
edited
Loading

👍 on this from me. Although, this probably has to be replicated in the package-template, right @astrofrog?

Longer-term, I agree it's not great to have two commands, and I'd be OK with deprecating build_sphinx... But I suspect there's some scripts in the CI or other places that assume it exists... perhaps the path forward is to switch the "real" command to build_docs (instead of build_docs being an alias for build_sphinx), and then have build_sphinx issue some kind of deprecation warning?

@adrn
Copy link
Member Author

adrn commented Jul 5, 2016

@eteq that seems like a fine idea -- I'll make an issue.

@adrn adrn mentioned this pull request Jul 5, 2016
Closed
@pllim pllim added Docs zzz 💤 astropy-helpers archived: PRs and issues related to astropy-helpers build Bug labels Jul 6, 2016
@adrn
Copy link
Member Author

adrn commented Jul 6, 2016

@pllim I don't think this particular PR is an astropy-helpers issue, but I think #5157 is

@pllim pllim removed the zzz 💤 astropy-helpers archived: PRs and issues related to astropy-helpers label Jul 6, 2016
@pllim
Copy link
Member

pllim commented Jul 6, 2016

@adrn , okay, I fixed the tags. Thanks!

@eteq
Copy link
Member

eteq commented Jul 6, 2016

This looks good and is pretty straightforward, so I'll merge this now. But @adrn or @astrofrog, can you make a PR to do this in the package-template too?

@eteq eteq merged commit 326b7d5 into astropy:master Jul 6, 2016
@astrobot
Copy link

astrobot commented Jul 6, 2016

@eteq - thanks for merging this! However, I noticed the following issues with this pull request:

  • The milestone has not been set
  • Changelog entry not present (or pull request number missing) and neither the Affects-dev nor the no-changelog-entry-needed label are set

Would it be possible to fix these? Thanks!

This is an experimental bot being written by @astrofrog - let me know if the message above is incorrect!

@eteq eteq mentioned this pull request Jul 6, 2016
Closed
This was referenced Jul 6, 2016
Merged
Closed
@pllim pllim added this to the v1.2.2 milestone Jul 7, 2016
@pllim
Copy link
Member

pllim commented Jul 7, 2016

I added some tags and a milestone to make the bot happy. Feel free to re-tag if wrong.

eteq added a commit that referenced this pull request Dec 21, 2016
@eteq
Merge pull request #5156 from adrn/docs/fix-docs-build-command
656281d 
Fix build_docs build path
@saimn saimn mentioned this pull request Jan 23, 2017
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

Bug build Docs no-changelog-entry-needed

Projects

None yet

Milestone

v1.2.2

Development

Successfully merging this pull request may close these issues.

4 participants

@adrn @eteq @pllim @astrobot