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

clean up of documentation files #4367

Merged
merged 6 commits into from Oct 19, 2013
Merged

clean up of documentation files #4367

merged 6 commits into from Oct 19, 2013

Conversation

ivanov
Copy link
Member

@ivanov ivanov commented Oct 9, 2013

This is mostly a decluttering PR to make way for future changes coming to the
way we organize and build our documentation.

Our README was out of date and hadn't been updated in ages. The attic
documents, likewise, have not been touched for a long time.

make help has been updated to list the very useful html_noapi target

Finally, I've removed the do_sphinx.py file, mostly because it does not
work, though I can be easily convinced to exclude that commit from this if
there's anyone who feels strong that it should stay in.

@ivanov
Copy link
Member Author

ivanov commented Oct 9, 2013

pinging @ellisonbg @jstenar and @efiring who have made commits to do_sphinx.py and might have insight as to whether or not it should stay.

@ivanov
Copy link
Member Author

ivanov commented Oct 9, 2013

pinging @fperez @ellisonbg and @paykroyd about the removal of docs/emacs/ipython.el which hasn't been updated since IPython 0.11 (Again, I can easily be convinced to revert this, but it seems as thought he file's been stale for a while now).

@efiring
Copy link
Contributor

efiring commented Oct 9, 2013

I don't have any real insight into do_sphinx.py, and personally I don't care whether it stays or goes. It looks like I ran into a problem with it back in 2011 after a Sphinx update, and my few changes were to fix that problem. It also looks like its only real function is to tweak the design of the LaTeX output, and thereby the pdf output. I gather from a commit comment by @fperez that pdf is no longer routinely produced; everyone uses html in practice.

@ivanov
Copy link
Member Author

ivanov commented Oct 14, 2013

it's been a week, so I'll go ahead an merge this tomorrow if I don't hear back otherwise

@takluyver
Copy link
Member

I thought someone was doing something with ipython.el last year, but perhaps it went into a separate repo?

@ivanov
Copy link
Member Author

ivanov commented Oct 16, 2013

according to @tkf in the discussion over on #1015, the standard python.el mode already supports IPython.

one last ping to @andreas-roehler @paykroyd and @deftpunk who were active in #1015:

I'm proposing the removal of docs/emacs/ipython.el which ships with IPython but has not seen an update in 2 years. Please voice your objection or approval

@damianavila
Copy link
Member

+1 for the removal...

@ivanov
Copy link
Member Author

ivanov commented Oct 19, 2013

ok, no objections, merging now

ivanov added a commit that referenced this pull request Oct 19, 2013
clean up of documentation files
@ivanov ivanov merged commit a8f3505 into ipython:master Oct 19, 2013
@ivanov ivanov deleted the doc-cleanup branch October 19, 2013 06:14
mattvonrocketstein pushed a commit to mattvonrocketstein/ipython that referenced this pull request Nov 3, 2014
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

4 participants