Error when building site with pdm

[tvdboom]

Hi,

I am checking that building the documentation works within a Github Actions job that looks like this:

  documentation:
    runs-on: ubuntu-latest
    steps:
      - name: Check out source repository
        uses: actions/checkout@v4
      - name: Set up pdm
        uses: pdm-project/setup-pdm@v4
        with:
          python-version: "3.11"
          cache: true
      - name: Install dependencies
        run: pdm sync -G doc --no-default
      - name: Build documentation
        run: pdm run mkdocs build --strict

Within my mkdocs.yml file I use pymdownx to run a python script when building the docs.

markdown_extensions:
    - pymdownx.superfences:
        preserve_tabs: true
        custom_fences:
            - name: python
              class: python
              format: !!python/name:docs_sources.scripts.formatter

The directory docs_sources is at the top of my repo. Unfortunately, running this yields the following error:

Before using pdm, I ran the command mkdocs build in the current venv and it worked correctly. Any ideas? Something related to the vitualenv?

Thanks

[pawamoy]

The difference is probably that pdm run does not add the current working directory to PYTHONPATH / sys.path. Therefore the MkDocs YAML loader cannot find docs_sources. To fix this, you have to add it yourself, for example by setting PYTHONPATH: . in your job env, or by running PYTHONPATH=. pdm run mkdocs build --strict.

[tvdboom]

thanks, that worked!

[frostming]

The difference is probably that pdm run does not add the current working directory to PYTHONPATH / sys.path

That is surprising, to me calling scripts via a subprocess should behave the same as running python in your terminal. Can you investigate more about why it is the case? @pawamoy

[pawamoy]

Indeed, if we activate the venv and run the command directly, sys.path is the same as when running with pdm run. So I'm not sure why mkdocs build previously worked with the venv activated.