Upgrade poetry and readthedocs to use dependency groups

nornir-automation / nornir

Pluggable multi-threaded framework with inventory management to help operate collections of devices

https://nornir.readthedocs.io/

Apache License 2.0

1.38k stars 234 forks source link

Upgrade poetry and readthedocs to use dependency groups #835

Closed ktbyers closed 1 year ago

ktbyers commented 1 year ago

Items in this PR:

Commented out codeql GitHub Action as it wasn't working (and wanted to focus on getting core CI working). Do we still need this? Is it worth fixing?
Commented out publish in GitHub Actions as it is broken (I assume for same reason as nornir_napalm) as they are both failing in the same way. I figured we would fix this on the next publish or when we fix nornir_napalm since it is the same issue.
Upgraded to poetry 1.3.2
Simplified pyproject.toml to use new dependency group format which is now supported by readthedocs (poetry install --with docs). Simplified some of the pyproject.toml structure and removed some things that didn't seem necessary any longer.
Upgraded .readthedocs.yaml to use RTD build V2 and new poetry dependency groups.

ktbyers commented 1 year ago

I tested this here and also on my read the docs account here:

https://nornir-ktbyers.readthedocs.io/en/poetry_test/

I also did some testing on an ubuntu machine, but that is probably redundant with the tests that are done on GitHub actions.

ktbyers commented 1 year ago

@dbarrosop I think this is good to go.

ktbyers commented 1 year ago

Poetry now allows creating dependency groups:

[tool.poetry.group.docs.dependencies]
sphinx = "4.5.0"
sphinx_rtd_theme = "1.0.0"
sphinxcontrib-napoleon = "^0.7"
jupyter = "1.0.0"
nbsphinx = "0.8.8"
pygments = "2.11.2"
sphinx-issues = "3.0.1"

And you can install them by using:

poetry install --with docs

Where "docs" is the group name.

readthedocs supports installing using this format.

dbarrosop commented 1 year ago

This is pretty amazing! Thanks!