A package for searching documentation built with sphinx
Project description
Doc-search
A simple package for searching documentation built with sphinx
Features
- Both async and sync support
- utilizes a cache to limit the number of requests being made
- works for any documentation that is built with sphinx
Example
asyncio
import asyncio
from doc_search import AsyncScraper
scraper = AsyncScraper()
async def main(query):
results = await scraper.search(query, page="https://docs.python.org/3/")
#returns a list of tuples in the format of [(item, url), (item, url)...]
if not results:
print("no results were found")
else:
for item, url in results: #loop through the list of results
print(f"{item} | {url}") #print out each result
asyncio.run(main("str.split"))
# to view the cache
# print(scraper.cache)
sync
from doc_search import SyncScraper
scraper = SyncScraper()
results = scraper.search("resize", page="https://pillow.readthedocs.io/en/stable/")
if not results:
print("no results were found")
else:
for item, url in results: #loop through the list of results
print(f"{item} | {url}") #print out each result
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
doc-search-1.0.1.tar.gz
(3.9 kB
view hashes)