Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Francesca L. Bleken <48128015+francescalb@users.noreply.github.com>
  • Loading branch information
jesper-friis and francescalb authored Oct 28, 2024
1 parent f87888f commit 815e191
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/contributors_guide/documentation_contributors.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ This include both the README files and documentation found in the `doc/` subdire

Generate documentation locally
------------------------------
When writing documentation it is practically to build and check the documentation locally before submitting a pull request.
When writing documentation it is practical to build and check the documentation locally before submitting a pull request.

The following steps are needed for building the documentation:

1. Install dependencies.

First you need [doxygen]. In Ubuntu it can be installed with

sudo apt-install doxygen
sudo apt install doxygen

Python requirements can be installed with

pip install --update -r requirements_doc.txt
pip install --upgrade -r requirements_doc.txt

2. Ask cmake to build documentation

Expand Down

0 comments on commit 815e191

Please sign in to comment.