Compiling local docs failed. Sphinx cannot find moin.

[gmilde]

Compiling the local Moin 2 documentation with both

moin/docs > make html

and

moin > ./m doc

led to the error:

...

  File "/usr/lib/python3/dist-packages/pkg_resources/__init__.py", line 414, in get_provider
    return working_set.find(moduleOrReq) or require(str(moduleOrReq))[0]
                                            ~~~~~~~^^^^^^^^^^^^^^^^^^

...

pkg_resources.DistributionNotFound: The 'moin' distribution was not found and is required by the application

Moin is installed in a venv that was activated at this time (running moin from the same directories worked nice).

[roland-ruedenauer]

Executing ./m docs worked at least for me.

Do you see moin listed when issuing pip list in your activated venv? You should see it it listed if you did install moin as (editable) package as part of your venv setup, which is done as part of excuting python quickinstall.py.

...
mdx-wikilink-plus             1.4.1
moin                          2.0.0b3.dev59+g57ba5d3f.d20250402 /home/roland/shared/workspace/moin
packaging                     25.0
...

Content of m-docs.txt afterwards:

sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v8.2.3
loading translations [en]... done
Converting `source_suffix = '.rst'` to `source_suffix = {'.rst': 'restructuredtext'}`.
[autosummary] generating autosummary for: admin/backup.rst, admin/changes.rst, admin/configure.rst, admin/index.rst, admin/install.rst, admin/maintenance.rst, admin/password-reset.rst, admin/requirements.rst, admin/serve.rst, admin/upgrade.rst, ..., user/markdown.rst, user/markups.rst, user/mediawiki.rst, user/moinwiki.rst, user/namespaces.rst, user/rest.rst, user/search.rst, user/subscriptions.rst, user/templates_metadata.rst, user/upload.rst
2025-12-10 13:18:02,322 ERROR moin.auth.ldap_login:33 You need to have python-ldap installed (No module named 'ldap').
2025-12-10 13:18:03,954 ERROR moin.auth.ldap_login:33 You need to have python-ldap installed (No module named 'ldap').

Build finished. The HTML pages are in _build/html.

[gmilde]

Do you see moin listed when issuing pip list in your activated venv?

Yes, it's there (with active venv).

You should see it it listed if you did install moin as (editable) package as part of your venv setup, which is done as part of excuting python quickinstall.py.

I did not run "quickinstall.py" but installed "per Hand".

Could it be, because I installed Sphinx system-wide, instead as in a venv?

[roland-ruedenauer]

Could it be, because I installed Sphinx system-wide, instead as in a venv?

I think so. Following the recommended devenv setup, you would install the docs requirements into your moin venv using ./m extras. And I see that docs/conf.py does attempt to locate moin, which requires it at least to be on the python search path (there might exist additional reasons that require moin and sphinx to reside in the same venv).

[gmilde]

Yes, it is the way conf.py determines the version number.
Tentatively replacing it with

import importlib
try:
    release = importlib.metadata.version('moin')
except importlib.metadata.PackageNotFoundError:
    release = "2.0 development"

solves the compiling problem.

The problem is that even when I start Sphinx from the active "moin-venv",
a systemwide installed Sphinx seems to "forget" this info when sourcing conf.py.

autodoc does not report errors on the console but the API documentation consists of just section headings...

Still, I can check my changes to the user documentation with Sphinx.