-
Notifications
You must be signed in to change notification settings - Fork 457
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
Fix: Links in Generated Documentation #4793
Conversation
Is this ready for review? |
Filtering the repo to find more, to avoid extra PRs. |
So the primary way that I know to review fixes for broken links is to wait until a PR like this is merged in, wait a little while until the doxygen task runs to generate new output from the changes, and then look at those. I do not mind learning how to take a PR and locally, on my own development system, run doxygen on the changes and look at them on my local system. Are there step-by-step instructions for doing that somewhere? |
This newly created issue summarizes my confusion with how to use doxygen on p4c: #4805 |
Yes, you can test the PR locally by checking out this PR.
git fetch upstream pull/4793/head
git checkout FETCH_HEAD |
f1f4b35
to
e544d54
Compare
Signed-off-by: Adarsh <[email protected]>
Signed-off-by: Adarsh <[email protected]>
Signed-off-by: Adarsh <[email protected]>
fixes: p4lang#4748 Signed-off-by: Adarsh <[email protected]>
Fixes: p4lang#4803 Signed-off-by: Adarsh <[email protected]>
Related to - p4lang#4804 Signed-off-by: Adarsh <[email protected]>
Signed-off-by: Adarsh <[email protected]>
Signed-off-by: Adarsh <[email protected]>
1fdda19
to
805ba36
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Given that these changes are fairly small and focused, and that it is easier to see what is fixed in the docs once the changes are merged in (yes, I know I can try out the changes locally on my system from the PR, without it being merged in), I would like to see this merged in, so we can look for issues in the generated docs after these changes are merged. If we end up with one or two extra PRs, I do not think that is a big issue, relative to knowing what we have generated from the latest main branch version of all files. |
For better Presentation of content in generated documentation.
Changes
Links fixed
on Main Page [P4 Compiler Documentation]
on Repository Page
on P4C Page