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

Extension documentation in Markdown #697

Open
jpellegrini opened this issue Oct 12, 2024 · 5 comments
Open

Extension documentation in Markdown #697

jpellegrini opened this issue Oct 12, 2024 · 5 comments

Comments

@jpellegrini
Copy link
Contributor

The documentation for extensions is still in markdown format, and is not compiled into PDF or HTML...
A user on reddit was looking for the documentation for gtklos, and thought it didn't exist. Maybe we should convert it to adoc and auto-generate it? Also explain in the README where the documentation can be found (or even better, in the reference manual)?

@jpellegrini
Copy link
Contributor Author

Oops. Actually,

  • Doc for gtklos exists in markdown, but is not generated
  • Doc for fuse does not exist (!)
  • Doc for curl exists, in adoc format, and is being generated, but it stays hidden in a subdirectory of that extension

@egallesio
Copy link
Owner

I'm surprised there is still some interest for building interfaces in Scheme. I thought that this interest was lost a long time ago, now that everything is HTML based. Great!

* Doc for gtklos exists in markdown, but is not generated

That's true. But it is in a bad shape (there is only the introduction). My idea was to auto-generate most of the documentation by using stklos-pp (by introspection of the classes, it is possible to have the list of the field of each class and, with a short preamble, it should suffice).

Anyway, I have just tried a conversion with pandoc what we already have and it is really better.
It should be generated.

* Doc for fuse does not exist (!)

Oops. It existed before. I have to dig in old archives to restore it.

* Doc for curl exists, in adoc format, and is being generated, but it stays hidden in a subdirectory of that extension

It is normal that it is hidden, because extensions are not built by default (they use external libraries which can be absent on a given system). In fact, a make install could eventually install it, with the rest of STklos documentation.

@egallesio
Copy link
Owner

Hello @jpellegrini,

Just a bunch of commits to add some documentation for GUIs in STklos (and show that I'm still alive). It is far from finished, and partially re-read.
A good part is generated automatically, but anyway, it takes more time than I thought. To change, I'll dig in the PRs and other Issues before finishing the document.

I have not converted yet the old documentation on fuse.

@jpellegrini
Copy link
Contributor Author

Hello @egallesio !
Thanks! I apologize for being silent recently - I'm dealing with personal issues, and will be back soon.
Anyway, it's great that the documentation is being updated and polished! 👍

@egallesio
Copy link
Owner

I feel sorry for you and hope these issues will be solved soon.
Take your time.

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