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

Fix Doxygen/docs links and expand documentation index page #1052

Merged
merged 2 commits into from
Nov 26, 2024
Merged

Conversation

enirolf
Copy link
Contributor

@enirolf enirolf commented Nov 26, 2024

No description provided.

@enirolf enirolf self-assigned this Nov 26, 2024
Copy link
Contributor

@martamaja10 martamaja10 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot - a few links don't work for me though.

@@ -8,5 +8,4 @@ sidebar:
---

The ROOT team has adopted [Doxygen](https://www.doxygen.nl){:target="_blank"} for generating
the [Reference Guide](https://root.cern/doc/master/){:target="_blank"}. In this section, you will find a number of conventions
and tips to be used in source code to generate proper documentation.
the [Reference Guide](https://root.cern/doc/master/){:target="_blank"}. In this section, you will find [our documentation guidelines](./guidelines.md), how to [run Doxygen locally](./local_doxygen.md), how to add [documentation for ROOT's pythonizations](./pythonizations.md) and a number of [useful tips formatting tips](./useful_tips.md).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those links don't work for me when I try it on: https://root.cern/1052/for_developers/docs/

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[our documentation guidelines], [run Doxygen locally], [documentation for ROOT’s pythonizations] and [useful tips formatting tips]

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops thanks for the catch -- should be fixed now!

Copy link
Contributor

@martamaja10 martamaja10 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, all looks good now!

@enirolf enirolf merged commit 325a457 into main Nov 26, 2024
1 check passed
@enirolf enirolf deleted the doxygen branch November 26, 2024 11:02
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

Successfully merging this pull request may close these issues.

2 participants