4 ms·

I've been working on this tool for a while that makes documentation easier and faster. The main idea is to have the code itself be the driver. Would love some f

• cmurf 7y ago
  The staggered screenshots that are ostensibly examples are all blank? Update: I see it works in Chrome but not in Firefox. Not sure why.
  • deleted 7y ago
    [deleted]
  • aliabd 7y ago
    Not sure either but will fix, thanks!
• j88439h84 7y ago
  Whoa.
• j88439h84 7y ago
  I want diagrams of my modules and how things are connected, such as one that shows "types defined in foo.py are used in bar.py". While you're generating docs from code, might think about diagrams.
  • aliabd 7y ago
    That's actually really dope, thanks! I bet we could do something there...
    • deleted 7y ago
      [deleted]
  • pncnmnp 7y ago
    Have you tried Pyreverse[1]? I used it for my Software Engineering course. From the documentation - Pyreverse analyses Python code and extracts UML class diagrams and package dependencies. [1] https://www.logilab.org/blogentry/6883 https://www.logilab.org/blogentry/6883
  • ChrisMarshallNY 7y ago
    I'm pretty sure Doxygen does that (http://doxygen.nl http://doxygen.nl).I used to use it all the time, but I use Jazzy, these days, and Jazzy does not do it.
• Aliabid94 7y ago
  This is something that I’ve felt is going to become very hot - some way of ensuring that documentation never goes stale. In the same vein as tests needing to pass before merging a commit, ensuring documentation is up to date when commiting. Looking forward to hearing more!
  • boustrophedon 7y ago
    Rust has a feature that somewhat provides this - doctests[1]. Rust doc comments begin with `///` and will be parsed as markdown when generating documentation. If there are codeblocks in the documentation comments, they will be run with all other tests and the test runner will report if the blocks fail to compile or if they error at runtime. So if the API changes, the example code in the documentation will fail to compile. [1] https://doc.rust-lang.org/rustdoc/documentation-tests.html https://doc.rust-lang.org/rustdoc/documentation-tests.html
    • kiwicopple 7y ago
      For anyone looking for something similar with JS, we wrote doctest-js: https://github.com/supabase/doctest-js https://github.com/supabase/doctest-js It allows you to write Unit Tests using JSDoc It won't necessarily stop your documentation from building but offers another good reason to document your code