search

PromyLOPh / pandora-apidoc

pandora.com API documentation
https://6xq.net/pandora-apidoc/
Do What The F*ck You Want To Public License
48 stars 19 forks source link

Add .. index:: directives to populate genindex.html #4

Closed winny- closed 9 years ago

winny- commented 9 years ago

I'm trying to make the documentation searchable in Dash, no luck so far, even so, this genindex.html is rather handy.

I also introduced two newlines between subsections in the document, this way it's easier to tell where one method's documentation starts and the other ends.

PromyLOPh commented 9 years ago

Hm, should we use “pair” for methods perhaps? See 14cd9baa6abf615c4b5ac2b25611b838ae2a0d4e

winny- commented 9 years ago

"pair" will make index entries with hierarchy "method" -> "user.somemethod", and "user.somemethod" -> "method".

I think we want:

.. index::
   single: method; user.somemethod
   single: user.somemethod
winny- commented 9 years ago

Oh. :-) Python 3's genindex does the same thing: https://docs.python.org/3/genindex-all.html

I'm going to push your commit to my pull request.

PromyLOPh commented 9 years ago

Oh. :-) Python 3's genindex does the same thing: https://docs.python.org/3/genindex-all.html Yeah, this seems to be the intended usage of pair. Merged.