Skip to content

Commit

Permalink
Handle feedbacks
Browse files Browse the repository at this point in the history
Signed-off-by: CARON Alice <alice.caron@rte-france.com>
  • Loading branch information
alicecaron committed Feb 20, 2025
1 parent 0641132 commit 3286359
Showing 1 changed file with 4 additions and 15 deletions.
19 changes: 4 additions & 15 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ They are published on powsybl.readthedocs.io/ and pull requests are built and pr

When modifying the website content, you can easily preview the result on your PC.

### From a terminal

Navigate to the "docs" directory of the project and run the following commands:

~~~bash
cd docs
~~~
Install the requirements the first time:
~~~bash
pip install -r requirements.txt
Expand All @@ -25,22 +25,11 @@ Or
~~~bash
make html
~~~
Or to build in latex format
Or to build the documentation in latex format:
~~~bash
make latexpdf
~~~

### From your IDE GUI

Install the requirements the first time:
~~~bash
pip install -r requirements.txt
~~~

~~~bash
sphinx-build -a . _build/html
~~~

### Preview the result

Then open `_build/html/index.html` in your browser.
Expand Down

0 comments on commit 3286359

Please sign in to comment.