-
Notifications
You must be signed in to change notification settings - Fork 0
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
The docs #49
Comments
I generated some new icons. doxygen/doxygen#6783 causes |
testing autolinking on InputHandler.cpp->InputHandler.h UserInput members |
FYI, Breathe doesn't make any effort to auto-link signatures to literal blocks of src code (doesn't use |
BTW, you don't need to manually add InputHandler/cli_gen_tool/docs/source/modules/cli_gen_tool.rst Lines 8 to 13 in 491d796
The literal blocks of src code is auto-generated by the viewcode ext... The generated code-blocks just don't occupy valuable screen real estate (they are separate pages that are cross-referenced automatically). As an example, I'll show you a link to my latest project's docs: https://circuitpython-homie.rtfd.io/en/latest/API/device.html#circuitpython_homie.HomieDevice. Notice the |
That's really cool! I'm having fun playing with all the options after reading through the documentation for breathe. What I really want is to be able to click a link in the brief or desc and it jumps to the function in the source. |
That feature doesn't exist for breathe. |
I'm looking through doxygen and seeing if that's possible. If it's in the XML as a link in the details it should show up, right? Then I just need to search and jump to the text somehow. I found this: https://caniuse.com/url-scroll-to-text-fragment |
and, as I envision it, the link is in the details and clicking on it jumps to the function in the raw source, highlights the function name text. |
I can tell you that the info required is output by Doxygen in the XML, but breathe doesn't do anything with it. In fact, the feature you're looking for is a long requested feature; I can't find the issue/thread anymore - they seem to have migrated the project to an org account named breathe-doc.
The |
Ok, I'm about to try something and I'll let you know in a few minutes if there's any fruit. |
works in chrome by default: works in firefox with this addon: |
Great that it works, but not great that readers would have to install an add-on in Firefox (I use Firefox). |
Another downside is that the search is not case sensitive. But it works which is all that matters to me and I can customize the link text to class::method. in Doxygen https://doxygen.nl/manual/autolink.html so I think this is feasible. Pretty cool. I put For browsers that aren't enabled it still jumps to the source in git, fails through. Working example: |
You can use MD notation for better readability in the doctring: [link text](linkURL) |
I'm going to try that right now, thanks! Great suggestion! |
I couldn't figure out the syntax to make it work, or maybe I am missing a setting in the Doxyfile. |
using the HTML tags works though so I'm going with that. |
Doxygen supports standard MarkDown syntax out-of-the-box, and what I suggested is a standard markdown hyperlink (breathe can translate it from XML). Are you sure you typed it right? Quotes aren't required for the URL, and you can use inline markup within the link's text. [`literal code` and regular text](https://github.com/dstroy0/InputHandler) should render like so: |
I was typing it in exactly like that and it was not working before but it is now. |
definitely was me not doing something right lmao |
Now I'm trying to get doxygen to parse my hacky C. Time to take a break hahahahahaha |
everything docs related is now in.... docs/ |
Layout is ok, I'm open to change. I need to go through all the variables and really document them. Add code snippets, rename parameters for clarity if needed.
The text was updated successfully, but these errors were encountered: