Coder Social home page Coder Social logo

Comments (5)

themightyoarfish avatar themightyoarfish commented on May 16, 2024

Would be awesome if you could use Sphinx's autodoc to have documentation generated for each function and submodule.

from hyperlearn.

themightyoarfish avatar themightyoarfish commented on May 16, 2024

It would be worth noting that the C extensions need to be built before the doc compiles properly. I also had to install psutil which wasn't listed in requirements.txt. Then makeing html actually succeeds in extracting the info from the docstrings.

I can make a PR unless you want to handle it yourself.

from hyperlearn.

danielhanchen avatar danielhanchen commented on May 16, 2024

@themightyoarfish Thanks for noticing that! Ye that's an issue I had to face as way. Just kept forgetting every time I uploaded to git, I need to remake the docs :) I'll do it today. Thanks! :)

from hyperlearn.

danielhanchen avatar danielhanchen commented on May 16, 2024

@themightyoarfish Hmmmm I tried to update ReadTheDocs.
Locally, it works. On their server, it says "No module named 'hyperlearn.cython.base'". etc etc.
I'll try fixing it again.

from hyperlearn.

danielhanchen avatar danielhanchen commented on May 16, 2024

Documentation has been fixed! https://hyperlearn.readthedocs.io/en/latest/source/hyperlearn.html
I will add more docstrings and clean some up today! :)

from hyperlearn.

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.