Skip to content

Commit

Permalink
Docs build fixes and pyproject cleanup
Browse files Browse the repository at this point in the history
Updates docs dependencies to cookiecutter versions so the RTD build will pass.
Fixes #187, removing Nautobot as an extra and setting the upper bound to 3.0.
  • Loading branch information
cmsirbu committed Oct 11, 2024
1 parent d95c322 commit c0d7d6a
Show file tree
Hide file tree
Showing 4 changed files with 106 additions and 38 deletions.
2 changes: 2 additions & 0 deletions 195.housekeeping
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Updates docs dependencies to cookiecutter versions so the RTD build will pass.
Fixes #187, removing Nautobot as an extra and setting the upper bound to 3.0.
9 changes: 5 additions & 4 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
mkdocs==1.5.2
mkdocs-material==9.2.4
mkdocs==1.6.0
mkdocs-material==9.5.32
mkdocs-version-annotations==1.0.0
mkdocstrings-python==1.5.2
mkdocstrings==0.22.0
griffe==1.1.1
mkdocstrings-python==1.10.8
mkdocstrings==0.25.2
123 changes: 95 additions & 28 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 4 additions & 6 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ packages = [
[tool.poetry.dependencies]
python = ">=3.8.1,<3.13"
# Used for local development
nautobot = ">=2.0.3,<=2.9999"
nautobot = ">=2.0.3,<3.0"

[tool.poetry.group.dev.dependencies]
bandit = "*"
Expand All @@ -48,14 +48,15 @@ toml = "*"
Markdown = "*"

# Rendering docs to HTML
mkdocs = "1.5.2"
mkdocs = "1.6.0"
# Material for MkDocs theme
mkdocs-material = "9.1.15"
mkdocs-material = "9.5.32"
# Render custom markdown for version added/changed/remove notes
mkdocs-version-annotations = "1.0.0"
# Automatic documentation from sources, for MkDocs
mkdocstrings = "0.25.2"
mkdocstrings-python = "1.10.8"
griffe = "1.1.1"
gitpython = "^3.1.41"
snakeviz = "^2.2.0"
nautobot-bgp-models = {git = "https://github.com/nautobot/nautobot-app-bgp-models.git", rev = "develop"}
Expand All @@ -64,9 +65,6 @@ ruff = "*"
to-json-schema = "^1.0.1"
json-schema = "^0.3"

[tool.poetry.extras]
nautobot = ["nautobot"]

[tool.black]
line-length = 120
target-version = ['py38', 'py39', 'py310', 'py311']
Expand Down

0 comments on commit c0d7d6a

Please sign in to comment.