Skip to content

Commit 325a457

Browse files
committed
Fix doxygen/docs links
1 parent e3ba2f0 commit 325a457

File tree

5 files changed

+6
-6
lines changed

5 files changed

+6
-6
lines changed

blog/_posts/2022-03-01-code-horsepower-f1.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ You can not only check the documentation with <kbd>F1</kbd>, but fully open the
8686

8787
Alternatively, you can also open the *Help Books* and search them using [Qt Assistant](https://doc.qt.io/qt-5/assistant-details.html). Linux *apt* packages are `qt4-dev-tools` or `qt5-assistant`, and the executables are `assistant-qt4` and `assistant`, respectively. (`qt6` version is not yet in the package manager.) You will have to add the `.qch` file to its database by going to "Edit", "Preferences", "Documentation", "Add".
8888

89-
And if you already use other IDEs or operating systems ? In addition to [inline HTML searching](https://www.doxygen.nl/manual/searching.html), the building of the (*ROOT*) doxygen documentation can be configured to output a format that is compatible with *MacOS* - [Xcode](https://www.doxygen.nl/manual/config.html#cfg_generate_docset), *Windows* - [VSstudio](https://www.doxygen.nl/manual/config.html#cfg_generate_htmlhelp), or [Eclipse](https://www.doxygen.nl/manual/config.html#cfg_generate_eclipsehelp). *ROOT* [only provides for download](https://root.cern/reference/) the *Qt* help files (`.qch`) for the moment, but you can [build the documentation yourself](https://root.cern/for_developers/doxygen/) adapting those flags in the *Doxyfile*.
89+
And if you already use other IDEs or operating systems ? In addition to [inline HTML searching](https://www.doxygen.nl/manual/searching.html), the building of the (*ROOT*) doxygen documentation can be configured to output a format that is compatible with *MacOS* - [Xcode](https://www.doxygen.nl/manual/config.html#cfg_generate_docset), *Windows* - [VSstudio](https://www.doxygen.nl/manual/config.html#cfg_generate_htmlhelp), or [Eclipse](https://www.doxygen.nl/manual/config.html#cfg_generate_eclipsehelp). *ROOT* [only provides for download](https://root.cern/reference/) the *Qt* help files (`.qch`) for the moment, but you can [build the documentation yourself](https://root.cern/for_developers/docs/) adapting those flags in the *Doxyfile*.
9090

9191
### The Power of Clang
9292

@@ -145,7 +145,7 @@ Beware:
145145

146146
QtCreator lets you not only find compilation errors, but also documentation errors, by interfacing with the warnings issued by *doxygen*. This metawarning function can prove extremely useful for detecting outdated or incorrect documentation and going to the right spot in the source code in just one click, rather than diving through [thousands of lines of output](https://lcgapp-services.cern.ch/root-jenkins/view/ROOT/job/root-makedoc-master/lastBuild/consoleText) and tracing it manually.
147147

148-
To give it a try, take a look at building the [ROOT documentation project](https://root.cern/for_developers/doxygen/). Follow these steps:
148+
To give it a try, take a look at building the [ROOT documentation project](https://root.cern/for_developers/docs/). Follow these steps:
149149

150150
- Call first `source /path/to/ROOT/bin/thisroot.sh` in the terminal and launch `qtcreator` from there. Alternatively, you can manually specify all the variables in the "Build" environment.
151151
- Import the *Makefile* located in `root/documentation/doxygen` into *QtCreator*, as explained [above](#open-a-c-cmake-project)

contribute/coding_conventions/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ In ROOT 5 all classes are in the `ROOT` namespace. Some packages will be in a su
5252
## Using comments
5353
ROOT chose [Doxygen](https://www.doxygen.nl){:target="_blank"} for its code documentation:
5454
please refer to
55-
[this page]({{'for_developers/doxygen' | relative_url}}) for all the details.
55+
[this page]({{'for_developers/docs' | relative_url}}) for all the details.
5656

5757
## Source file layout
5858

for_developers/docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ sidebar:
88
---
99

1010
The ROOT team has adopted [Doxygen](https://www.doxygen.nl){:target="_blank"} for generating
11-
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).
11+
the [Reference Guide](https://root.cern/doc/master/){:target="_blank"}. In this section, you will find [our documentation guidelines]({{'for_developers/docs/guidelines' | relative_url}}), how to [run Doxygen locally]({{'for_developers/docs/local_doxygen' | relative_url}}), how to add [documentation for ROOT's pythonizations]({{'for_developers/docs/pythonizations' | relative_url}}) and a number of [useful tips formatting tips]({{'for_developers/docs/useful_tips' | relative_url}}).

for_developers/docs/pythonizations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar:
77
nav: "for_developers"
88
---
99

10-
Some ROOT classes have *pythonizations* that require additional documentation. These can be added as special boxes to the rendered Doxygen page of their corresponding C++ class. As an example, see the Python-specific [RDataFrame](https://root.cern/doc/master/classROOT_1_1RDataFrame.html#python) docs. This documentation is written in the pythonization files corresponding to the original C++ class, which can be found in `<root_sources>/bindings/pyroot/pythonizations/python/ROOT/_pythonization`. Documentation is added as a module-level docstring, which should following the template below, replacing `{CLASS_NAME}` with the corresponding C++ class name, `{BLOCK_TITLE}` with the title of the documentation block (in most cases, "PyROOT" is used) and `{DOCUMENTATION_BODY}` with the documentation body, which supports the usual Doxygen tags and other formatting methods (see also the [documentation formatting tips](../useful_tips)).
10+
Some ROOT classes have *pythonizations* that require additional documentation. These can be added as special boxes to the rendered Doxygen page of their corresponding C++ class. As an example, see the Python-specific [RDataFrame](https://root.cern/doc/master/classROOT_1_1RDataFrame.html#python) docs. This documentation is written in the pythonization files corresponding to the original C++ class, which can be found in `<root_sources>/bindings/pyroot/pythonizations/python/ROOT/_pythonization`. Documentation is added as a module-level docstring, which should following the template below, replacing `{CLASS_NAME}` with the corresponding C++ class name, `{BLOCK_TITLE}` with the title of the documentation block (in most cases, "PyROOT" is used) and `{DOCUMENTATION_BODY}` with the documentation body, which supports the usual Doxygen tags and other formatting methods (see also the [documentation formatting tips]({{'for_developers/docs/useful_tips' | relative_url}})).
1111

1212
```
1313
r"""

for_developers/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ ROOT externals coming from the central installations in AFS or CVMFS.
4242
- [Jenkins Service](https://lcgapp-services.cern.ch/root-jenkins/)
4343
- [Bug Reports](https://github.com/root-project/root/issues/new)
4444

45-
### [Doxygen in ROOT]({{'/for_developers/doxygen' | relative_url}})
45+
### [Documentation in ROOT]({{'/for_developers/docs' | relative_url}})
4646
[Doxygen](https://www.doxygen.nl/){:target="_blank"} is used for generating
4747
the [Reference Guide](https://root.cern/doc/master/){:target="_blank"}.
4848

0 commit comments

Comments
 (0)