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

add tags to robodoc #101

Open
mdedwards opened this issue May 4, 2024 · 2 comments
Open

add tags to robodoc #101

mdedwards opened this issue May 4, 2024 · 2 comments

Comments

@mdedwards
Copy link
Owner

We should add tags to various methods and functions to show in which scenarios particular algorithms are useful. For instance, the tag transitions would be useful for both Fibonacci transitions and the procession algorithm.

Robodoc accepts the TAGS keyword, and will pull it into the HTML and other documentation format (e.g. https://michael-edwards.org/sc/robodoc/l-for-lookup_lsp.html#robo283), but it won't provide a link to those tags at the top right of the generated, HTML page, for instance, where functions, methods et cetera are linked. A single page with all of the tags listed, along with links to the code documentation for the particular functions and methods would be essential if this is to be at all useful.

@rubenphilipp
Copy link
Collaborator

I investigated robodoc as well and had a brief look at the source where I wasn't able to locate any function for generating such a "tags-index". What about writing an issue to the robodoc repository (https://github.com/gumpu/ROBODoc)? It seems not to be completely inactive (at least the most recent commit dates to last year).

@mdedwards
Copy link
Owner Author

Hello Ruben, it wouldn't hurt to ask I suppose, but I wouldn't hold my breath ;-)

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