Code Monkey home page Code Monkey logo

Comments (2)

janbuchar avatar janbuchar commented on August 25, 2024

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.

barjin avatar barjin commented on August 25, 2024

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.