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

Windows make file for Sphinx documentation #2104

Merged
merged 1 commit into from Jul 14, 2012

Conversation

debjan
Copy link

@debjan debjan commented Jul 5, 2012

As discussed in this issue I'm hopefully doing valid pull request to IPython, asking for permission to add make.cmd to IPython repository.

This small batch script would allow using basic make <target> command syntax for building Sphinx documentation on Windows.

@Carreau
Copy link
Member

Carreau commented Jul 11, 2012

Well, I don't think any of the core devs use windows, my take on that would be to merge as is.
I would gladly tag as SciPy-2012-Sprint to get feedback as some people might have windows there, so we can have people trying to build on different version, but github does not allow tag on PR...

@debjan
Copy link
Author

debjan commented Jul 12, 2012

Hm, it's really just a simple batch file executing same command with additional arguments. And it's not that important to be thorough tested. Windows user can of course instead, look in a bash make script and deduce source/destination than launch desired command and arguments, but it's more convenient to just go with make latex i.e.. I guess that's the purpose of provided make file

Before replying I searched for other possible projects that use Sphinx, and on first results - scikit-learn, scikits-image, they all have batch version for the Sphinx make file, too. It seems similar to above only that they are straight forward without structure. FWW from the looks it also seems like you guys can just grab make.bat from scikits-image and it will work for IPython too; scikit-learn uses different source/destination folders, but it's like same batch file as in scikits-image. Also Pandas has make.py which is yet another approach.

As a side note, I'm not a promoter of any OS, nor want to discredit, I've used various variants of Linux and Windows (including latest preview release) and currently I use both Linux (Ubuntu makes my life easy) and Windows (XP makes it even more easier) and I can't see reasonable reason to change any of it. But what fascinates me, is that above average PC users like you, can't read simple batch file for the OS that is most widely used across the world. I mean, wanting or not, circumstances can lead to face a PC with Windows installed on it. I don't understand the aversion, it doesn't seem realistic to me.

@debjan
Copy link
Author

debjan commented Jul 13, 2012

ha, ha,... various variants and reasonable reason...
Funny. What else had I wrote too? Nevermind...

@minrk
Copy link
Member

minrk commented Jul 14, 2012

As @Carreau said, we often don't have Windows to test. This is not an argument against such things, only that Windows fixes are more likely to be merged without testing. Since this is an attempt at an entirely new feature and Windows-only, I am fine merging as-is, since I presume it works for at least one person, or you wouldn't have submitted it. Thanks!

minrk added a commit that referenced this pull request Jul 14, 2012
Windows make file for Sphinx documentation
@minrk minrk merged commit 0ccb93e into ipython:master Jul 14, 2012
mattvonrocketstein pushed a commit to mattvonrocketstein/ipython that referenced this pull request Nov 3, 2014
Windows make file for Sphinx documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants