Comments (2)
Paging @barjin - could you provide some details about how we generate docs for the Python SDK?
From https://stackoverflow.com/questions/51125415/how-do-i-document-a-constructor-for-a-class-using-python-dataclasses it seems that sphinx can indeed handle Args:
in the docblock in a reasonable fashion.
from crawlee-python.
Following the in-office discussion, I'm sharing this here, so we can refer to it:
The current API reference for Python projects is an amalgamation of pydoc-markdown
, existing tools we have for JS projects and one very ugly python-syntax-tree to javascript-syntax-tree conversion script (plus a pinch of bash scripts).
It's by no means a good solution - having something new, clean and cool in this project would be very nice (as we could then port it from here to all the other repos. Sorry to let you all down :(
from crawlee-python.
Related Issues (20)
- Finalize release process HOT 2
- how can I disable cache completely ? HOT 1
- Improve saving-data guide HOT 1
- This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
- accept patch/minor/major as the release type
- Would be great with a user guide.
- support for launching with user provided profile
- Add fingerprint injector for Playwright crawler
- Add fingerprints for HTTPX client HOT 1
- Evaluate the efficiency of opening new Playwright tabs versus windows HOT 1
- PlaywrightCrawler sometimes hangs after reaching max_requests_per_crawl
- Remove dependency on `aiofiles` and `aioshutil`
- Feature Request: Add More Options to Crawlee CLI for Crawler Creation
- URL Validation edge case - Protocol/Scheme relative URLs HOT 12
- Does the crawlee-python supports preNavigationHooks? HOT 3
- Unify `crawlee.memory_storage_client.request_queue_client` with JS counterpart
- Make memory-related parameters of `Snapshotter` configurable via `Configuration`
- Crawler runs into infinite loop and won't stop on request limit calling the handler again and agin for the same context HOT 1
- Continious scraping request HOT 1
- item_count double incremented when reloading dataset HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from crawlee-python.