Skip to content

fix instructions for building documentation with doxygen #1050

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.

Sign up for GitHub

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

Closed
m-fila wants to merge 2 commits into from
Closed

fix instructions for building documentation with doxygen #1050

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d623399
fix doxygen generation instructions
m-fila Nov 25, 2024
6a3d0b5
Apply suggestions from code review
m-fila Nov 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions for_developers/doxygen/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ and tips to be used in source code to generate proper documentation.

## How to generate locally the doxygen documentation
Developers can generate the documentation locally to review the results of their changes
before committing them to the repository. The process is as follows:
before committing them to the repository. First build (and optionally install) ROOT, then the process is as follows:

{% highlight sh %}
$ cd <root_sources>/documentation/doxygen
$ source <root_sources>/bin/thisroot.sh
$ source <root_install_or_build_location>/bin/thisroot.sh
$ make
{% endhighlight %}

Expand Down
Loading