pycco-docs / pycco

Literate-style documentation generator.

Home Page:https://pycco-docs.github.io/pycco/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Searchable index page?

kmatt opened this issue · comments

Looking for the correct approach to make the generated index page searchable. Without adding a bunch of search code and weight, was thinking of adding the docstring to each link, or perhaps a tag option if docstrings muck up the index page too much. Then search could be a simple Find operation in the browser.

Is there a convention for this being considered, especially tags in docstrings? If the docstrings are long, can a collapse be added to the css yet still make the full text browser searchable?

Personally, looking to use this for both Python and SQL - largely the latter.