Skip to content

Commit

Permalink
Update docs dependencies (networktocode#356)
Browse files Browse the repository at this point in the history
  • Loading branch information
itdependsnetworks authored Aug 29, 2023
1 parent 1bed7bc commit aa2b9aa
Show file tree
Hide file tree
Showing 6 changed files with 519 additions and 497 deletions.
2 changes: 1 addition & 1 deletion docs/dev/dev_environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Poetry is used in lieu of the "virtualenv" commands and is leveraged in both env
The `pyproject.toml` file outlines all of the relevant dependencies for the project:

- `tool.poetry.dependencies` - the main list of dependencies.
- `tool.poetry.dev-dependencies` - development dependencies, to facilitate linting, testing, and documentation building.
- `tool.poetry.group.dev.dependencies` - development dependencies, to facilitate linting, testing, and documentation building.

The `poetry shell` command is used to create and enable a virtual environment managed by Poetry, so all commands ran going forward are executed within the virtual environment. This is similar to running the `source venv/bin/activate` command with virtualenvs. To install project dependencies in the virtual environment, you should run `poetry install` - this will install **both** project and development dependencies.

Expand Down
6 changes: 3 additions & 3 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
mkdocs==1.4.3
mkdocs==1.5.2
# Material for MkDocs theme
mkdocs-material==8.5.8
mkdocs-material==9.2.4
mkdocs-python-classy==0.1.3
# Render custom markdown for version added/changed/remove notes
mkdocs-version-annotations==1.0.0
# Automatic documentation from sources, for MkDocs
mkdocstrings==0.22.0
mkdocstrings-python==1.4.0
mkdocstrings-python==1.6.0
7 changes: 4 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,14 @@ theme:
- "python"
- "yaml"
features:
- "navigation.tracking"
- "content.code.copy"
- "navigation.indexes"
- "navigation.tabs"
- "navigation.tabs.sticky"
- "search.suggest"
- "navigation.tracking"
- "search.highlight"
- "search.share"
- "navigation.indexes"
- "search.suggest"
favicon: "assets/favicon.ico"
logo: "assets/networktocode_logo.svg"
palette:
Expand Down
Loading

0 comments on commit aa2b9aa

Please sign in to comment.