search

ioam / ioam-builder

Code for building documentation and running tests across IOAM
1 stars 1 forks source link

Document how other projects should use these extensions #3

Open timsnyder opened 7 years ago

timsnyder commented 7 years ago

I'm creating a sphinx setup for CAT. I'm running into the nice terminal control characters in my output and I'm guessing that I need to use the extensions in this repo to get sphinx to nicely render documentation of my classes that use param.

I see from sphinx documentation how I can run sphinx-quickstart and sphinx-apidoc to get bootstrapped but I don't understand how to add this repo as a sphinx extension so that I can use it. Holoviews seems to just call into this for it's building as opposed to using a more standard looking sphinx setup that has extensions from this repo listed in the conf.py.

Can you guys point me in the right direction and possibly document this?

cc: @groutr & @jackjchen FYI

timsnyder commented 7 years ago

Oops. Nevermind about the pointer to how to use it. I was confused by how param was using it but holoviews uses it in a way that's more consistent with what I'm looking for. Still, it might be nice to document how a project should hook this extension into their sphinx config and give pointers to various projects that are known to use it as examples. This could be done in the README.md for the repo. Doesn't need to be fancy. :smiley_cat:

jlstevens commented 7 years ago

I really hope I get a chance to improve our paramdoc extension someday. It was put together very quickly and improving it would really help the HoloViews API documentation...