Skip to content

Resolve "`mkdocs build` command fails when running `make run`"

Chris Zubak-Skees requested to merge 49-fix-mkdocs-failure into main

This MR resolves two issues with the make docs command encountered when running make run:

  1. It uses the mkdocs in the local environment.
  2. It does a minor upgrade to mkdocstrings-python version 1.10.8 from 1.10.5 to resolve a dependency mismatch.

Steps to test:

  1. Run rm -rf site.
  2. Switch to the main branch and run make dev-depends.
  3. Deactivate your Python environment, as this would be the case on a first run from someone just setting up the project.
  4. In the project root, run make docs. It should fail.
  5. Switch to 49-fix-mkdocs-failure.
  6. Run make docs. It should still fail, but with a different error.
  7. Run make dev-depends.
  8. Run make docs. It should succeed.

Closes #49 (closed)

Edited by Chris Zubak-Skees

Merge request reports

Loading