DOC: Solve Dependencies Conflicts and pyproject build

[phmbressan]

Pull request type

• [X] Code changes (bugfix, features)
• [X] ReadMe, Docs and GitHub updates

Checklist

• [X] Docs have been reviewed and added / updated
• [X] Lint (black rocketpy/ tests/) has passed locally
• [ ] All tests (pytest tests -m slow --runslow) have passed locally
• [x] CHANGELOG.md has been updated (if relevant)

Note: --runslow is currently failing.

Current behavior

An error occurs while trying building docs due to many reasons, including:

• New release of docutils not supported by m2r2;
• pyproject.toml requires conf.py changes;
• lxml separated its html_clean to another repo for security.

All those library changes happened around late april and beginning of may.

New behavior

The following changes were made:

• Limit docutils version to 0.20.1;
• Add to docs/requirements the new lxml_html_clean;
• Add PYTHONPATH to conf.py.

Following sphinx docs recommendation, in order to avoid breaking docs due to dependency updates pip-tools was used to pin down all docs dependencies.

The following procedure should be followed to add/update a docs dependency:

1. Add the new top-level dependency to docs/requirements.in;
2. Run pip-compile docs/requirements.in.

Docs are building now:


Breaking change

• [ ] Yes
• [X] No

Additional information

The PR #584 removes README.md from the docs, allowing the removal of m2r2 dependency and the limitation of docutils version.

[codecov[bot]]

Codecov Report

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

Project coverage is 73.56%. Comparing base (836cde7) to head (73ec844). Report is 1 commits behind head on develop.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## develop #613 +/- ## ======================================== Coverage 73.56% 73.56% ======================================== Files 70 70 Lines 10313 10313 ======================================== Hits 7587 7587 Misses 2726 2726 ```

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

[phmbressan]

There are some comments added automatically at the top of docs/requirements.txt which specify what you mentioned.

I don't know if you have seen those, but if you think that it is not enough, I can add a line on top of requirements.in with the same.

[Gui-FernandesBR]

There are some comments added automatically at the top of docs/requirements.txt which specify what you mentioned.

I don't know if you have seen those, but if you think that it is not enough, I can add a line on top of requirements.in with the same.

OK, Good, that's enough, I haven't seen those before. All good.