Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documenting with sphinx? #199

Open
viktorfreiman opened this issue Jan 31, 2024 · 1 comment
Open

Documenting with sphinx? #199

viktorfreiman opened this issue Jan 31, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation question Further information is requested

Comments

@viktorfreiman
Copy link

Is there any plans on start using sphinx and auto generating api documentation instead of having to manual type in the readme?

It would be nice to move the docs over to something like readthedocs and make it autobuild on master

@Krukov
Copy link
Owner

Krukov commented Feb 4, 2024

Hello.

Yes that is a thing that I thought about a long time ago. But I still have a doubt that it is better than just Readme. I usually try to find an answer in a readme and only than opening a "full documentation"

@Krukov Krukov added documentation Improvements or additions to documentation question Further information is requested labels Feb 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants