home.social

#pydoc — Public Fediverse posts

Live and recent posts from across the Fediverse tagged #pydoc, aggregated by home.social.

fetched live
  1. Maybe not, pydoc-markdown (github.com/NiklasRosenstein/py) looks like it just yanks out the right parts, and doesn't do any filtering or manipulating. Score!

    #python #markdown #pydoc-markdown

  2. Maybe not, pydoc-markdown (github.com/NiklasRosenstein/py) looks like it just yanks out the right parts, and doesn't do any filtering or manipulating. Score!

    #python #markdown #pydoc-markdown

  3. Discovered, or possibly rediscovered, that for documenting Python modules « python -m pydoc -w png » will produce HTML documentation of the png module. And pydoc is in the Python Standard Library. AFAICT the only styling is automatically produced hyperlinks. I had a quick look at the code (to see if there were any undocumented styling features), and my impression was "plenty of attack surface here". (for example, pydoc includes a web server).

    #Python #pydoc

  4. Discovered, or possibly rediscovered, that for documenting Python modules « python -m pydoc -w png » will produce HTML documentation of the png module. And pydoc is in the Python Standard Library. AFAICT the only styling is automatically produced hyperlinks. I had a quick look at the code (to see if there were any undocumented styling features), and my impression was "plenty of attack surface here". (for example, pydoc includes a web server).

    #Python #pydoc

  5. @serge @helge

    I don't quite understand that difference. #PyDoc uses either docstrings or the comments above a function/module/class/etc. as the comment I'd expect Sphinx to do the same:
    docs.python.org/3/library/pydo (see paragraph two).

  6. @serge @helge

    I don't quite understand that difference. #PyDoc uses either docstrings or the comments above a function/module/class/etc. as the comment I'd expect Sphinx to do the same:
    docs.python.org/3/library/pydo (see paragraph two).

  7. @serge many of the projects we use in Python, like #Flask, are documented using #Sphinx, which can be configured to automatically generate API documentation from Python source code:

    sphinx-doc.org/en/master/tutor

    This is (similar to the #yardoc and #rdoc situation) backwards compatible with #pydoc, though much more expressive due to the machine-readable format for defining parameters, return values and potential exceptions:

    sphinx-doc.org/en/master/tutor

    docs.python.org/3/library/pydo

  8. @serge many of the projects we use in Python, like #Flask, are documented using #Sphinx, which can be configured to automatically generate API documentation from Python source code:

    sphinx-doc.org/en/master/tutor

    This is (similar to the #yardoc and #rdoc situation) backwards compatible with #pydoc, though much more expressive due to the machine-readable format for defining parameters, return values and potential exceptions:

    sphinx-doc.org/en/master/tutor

    docs.python.org/3/library/pydo

  9. #python stdlib has a generated code documenter shoved into it: #pydoc. It has a lot of design problems, top of which is that it works poorly as a pure CI task to generate static HTML.

    I forked it and made it at least usable, albeit still ugly.

    github.com/matthewdeanmartin/p

    Next step would be to use modern website templating. Maybe if it ever got attention & I felt peer pressure to improve it again.

  10. #python stdlib has a generated code documenter shoved into it: #pydoc. It has a lot of design problems, top of which is that it works poorly as a pure CI task to generate static HTML.

    I forked it and made it at least usable, albeit still ugly.

    github.com/matthewdeanmartin/p

    Next step would be to use modern website templating. Maybe if it ever got attention & I felt peer pressure to improve it again.