Fix command for installation of docs dependencies in the guide.

sfmig commented 1 month ago

Description

What is this PR

[ ] Bug fix
[ ] Addition of a new feature
[x] Other

Why is this PR needed?

It fixes the installation instructions for the docs dependencies
- more details on the next section.
It combines all the dependencies installations into the same section.
- Right now, the contributors first install movement in a development environment, and then install a few more additional dependencies to be able to build the docs locally in a later section. In this PR I put both steps in the same section.
Some small updates to the phrasing
- e.g., make clean html cleans and re-builds the docs, so there is no need to run the build command again as the text suggests.

What does this PR do? The docs requirements.txt file specifies the installation of the movement package on its first line, as -e .. The dot syntax refers to the current directory (the one executing the command), and it should match the location of the movement metadata file (pyproject.toml for us).

Since pyproject.toml is at the root of the directory, this means the command is expected to be run from the root of the directory too.

However, the documentation asks to run the pip install -r requirements.txt command from the docs directory. If this instructions are followed, we get an error because pip is unable to find the pyproject.toml file for the movement package.

Note that in CI we run the same command that this PR proposes (see here)

References

\

How has this PR been tested?

\

Is this a breaking change?

No.

Does this PR require an update to the documentation?

\

Checklist:

[x] The code has been tested locally
[ n/a ] Tests have been added to cover all new functionality
[x] The documentation has been updated to reflect any changes
[x] The code has been formatted with pre-commit

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 99.77%. Comparing base (a42838d) to head (158f52f). Report is 1 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #323 +/- ## ======================================= Coverage 99.77% 99.77% ======================================= Files 15 15 Lines 909 909 ======================================= Hits 907 907 Misses 2 2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.