add documentation.

[simulacrum6]

Currently there is no external documentation for the package api. All api functions have a docstring though. There are plenty of automatic documentation tools to create a documentation from those.

Docstrings should probably be extended to also include usage examples.

• [ ] Add tool for automatic documentation generation.
• [ ] Extend API docstrings to contain a clear explanation, argument descriptions and usage examples.

[zahertalab]

Hi

Let me make a try.

[simulacrum6]

Hey, thanks for your offer! What did you have in mind? The automatic documentation tool or working on the docstrings?

[zahertalab]

I'm thinking of automatic documentation tools right now. Have you some of them?

[simulacrum6]

Okay, cool.

There are some out there. Sphinx is pretty common. It generates documentation from docstrings and the output can be integrated with readthedocs and setuptools (which we use for building the project).

So if you want to integrate Sphinx, you are more than welcome.

[zahertalab]

Ok, this is my first time to corporate. I'm just seeing how to use Github. For your issue, where I can start? setuptools give me 404!

[simulacrum6]

Fork the repository and read up on how to set up Sphinx and then generate the Documentation using that tool. When you have a working solution, create a pull request. Don't worry about the rest for now.

[zahertalab]

Yes, thank you. I'm learning about them for the last few days. And I hope to start soon. Thanks for your patience!

[AbuTuraab]

Hi there, let me help you with your documentation.

[zahertalab]

OK. Now, where to find the package api?

[zesch]

What do you mean?

[zahertalab]

Currently there is no external documentation for the package api. All api functions have a docstring though. There are plenty of automatic documentation tools to create a documentation from those.

I mean this

[zesch]

https://github.com/ltl-ude/inceptalytics/blob/main/inceptalytics/analytics.py