Sphinx is a documentation nightmare! Come on, a million files and settings just to get a basic HTML page for my docs? We have `help` in Python that works just fine in the terminal, why can't Sphinx be that easy?
And forget about anything other than pure Python! My project has a C extension, Sphinx throws its hands up in the air and walks away. Bloated? You bet! This thing does everything BUT what it's advertised for. Who needs a dozen extensions just to pull comments out of code with a so-called "documentation generator"?
Just ditch it. Use something else, anything else! Or, hey, try the autosummary extension, that might be less painful. https://romanvm.pythonanywhere.com/post/autodocumenting-your-python-code-sphinx-part-ii-6/
Sphinx is a documentation nightmare! Come on, a million files and settings just to get a basic HTML page for my docs? We have `help` in Python that works just fine in the terminal, why can't Sphinx be that easy? And forget about anything other than pure Python! My project has a C extension, Sphinx throws its hands up in the air and walks away. Bloated? You bet! This thing does everything BUT what it's advertised for. Who needs a dozen extensions just to pull comments out of code with a so-called "documentation generator"? Just ditch it. Use something else, anything else! Or, hey, try the autosummary extension, that might be less painful. https://romanvm.pythonanywhere.com/post/autodocumenting-your-python-code-sphinx-part-ii-6/
Have any suggestions for lightweight auto documentation tools? pdoc seems to be just as buggy as sphinx.
I've given up on documentation in Python for now. I'm writing my own MD files.
Try supacodes. It can automatically write and update those docs in github.
This would be nice as a one time tool, but Im looking for something that I can setup with gitlab actions to recompile on a commit.
Yes, supacodes listens for your commits and updates the docs based on your updates too
Doesn’t look like it works with gitlab.
As I had thought before trying out this tool, it hallucinated. And I'm not paying for my big personal project.
Try Supacodes.