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

Documentation on kivent.org via sphinx #112

Closed
cthilhi opened this issue Jan 13, 2016 · 1 comment
Closed

Documentation on kivent.org via sphinx #112

cthilhi opened this issue Jan 13, 2016 · 1 comment

Comments

@cthilhi
Copy link

cthilhi commented Jan 13, 2016

For beginners the documentation on kivent.org is pretty thin, could we get a more complete version?

You say here:
"Most of these Classes have cdefed functions that cannot be read by Sphinx. Read the source if you want to find out more about using them."
.. that sphinx is the problem but maybe there's a workaround? (seems possible after googling)

In the meantime, reading the source is fine, it's just harder for newcomers ...

Thanks!

@Kovak
Copy link
Contributor

Kovak commented Jan 13, 2016

To my knowledge, there is still no way to have the docs to cdefed functions read by sphinx without doubling the entire cdefed api with mock python functions. Which could potentially be a solution, but a bit of a pain in the ass.

Better learning materials are definitely on my mind, and this includes things like solving this doc problem.

@Kovak Kovak closed this as completed Jun 3, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants