Documenting SymPy gamma

[debugger22]

If we can, we should create sphinx generated documentations for SymPy gamma. This will help newcomers in understanding the code mainly the logic module.

[debugger22]

@lidavidm ping.

[lidavidm]

Perhaps if the code is unclear we should refactor/simplify it and add comments, and document higher-level structure on the wiki. Full-blown Sphinx documentation is (in my opinion) a rather large hassle for a relatively small codebase.

[debugger22]

At least we should start adding docstrings. When more features like NLP will be added, it will become really tough to understand the code base.

[asmeurer]

Are you talking about user documentation or developer documentation?

[asmeurer]

If it's developer documentation, I would just focus on documentation that lives in the code itself, i.e., docstrings, comments, etc. Sphinx is better for user documentation.

[asmeurer]

And if it's user documentation, I don't see the need. SymPy Gamma is pretty self explanatory. If something is confusing, we should try to fix that thing to be easier to use, not try to document it.

The only thing that maybe could be "documented" is a list of all the special things that Gamma recognises. This would just be a small list (possibly auto-generated), on a page somewhere.

[debugger22]

I am talking only about developer docs.

[debugger22]

I agree with you that user documentation is indeed not required. I was just trying to understand the code and felt the need of docstrings.