qtconsole icon indicating copy to clipboard operation
qtconsole copied to clipboard

Docs

Open takluyver opened this issue 10 years ago • 8 comments

Making an issue so it doesn't get forgotten. Assign yourself if you want to work on this

There's a simple skeleton of docs there, but we should:

  • [x] Update stuff (e.g. it's now jupyter qtconsole)
  • [ ] Document its config options. I have some machinery to do this in the ipython docs.
  • [ ] Create API docs (particularly considering the use case of embedding it as a Qt widget)
  • ~~Get it building on RTD~~

takluyver avatar May 27 '15 22:05 takluyver

We don't have API docs, yet. Marking that for 4.1

minrk avatar Jul 20 '15 20:07 minrk

rtd now support conda and potentially rtd.yml cf https://github.com/rtfd/readthedocs.org/issues/857 might be woth looking into.

Carreau avatar Jan 05 '16 10:01 Carreau

Docs page for rtd:

  • http://docs.readthedocs.org/en/latest/conda.html
  • http://docs.readthedocs.org/en/latest/yaml-config.html

Carreau avatar Jan 05 '16 10:01 Carreau

I don't think this is ready for 4.2. @takluyver?

ccordoba12 avatar Feb 14 '16 18:02 ccordoba12

This is not. If we're aiming to get 4.2 out soon, it's fine to bump this.

takluyver avatar Feb 14 '16 18:02 takluyver

Yes, we are, specially for the fixes to Latex support.

ccordoba12 avatar Feb 14 '16 19:02 ccordoba12

OK. I've created a new 4.3 milestone and set it to that, on the grounds that it does still make sense to add API docs for a minor release if we do another 4.x release.

takluyver avatar Feb 14 '16 19:02 takluyver

Ok. I just moved this to 5.0 because I didn't find another milestone available.

ccordoba12 avatar Feb 14 '16 19:02 ccordoba12