mkdocs not producing python code documentation about mkdocs

[pawamoy]

Hello.

Any output coming from the setup commands is discarded, because the legacy Python handler reads the output of pytkdocs and loads it as JSON. Your print statement would break that if we didn't discard it.

Not sure what you mean about forwarding to a file: these are Python statements, not shell commands, so > is an operator here, not the shell redirection symbol.

About not seeing any API docs generated, I invite you to open an issue in https://github.com/mkdocstrings/python-legacy. But before that: have you tried the new handler? It's much better than the legacy one :)

[vkuehn]

Hello,

usually I can write log output that way to text files.

Not really sure how to diasable the old handler and use the new one.
I have that in poetry.lock

[package.extras]
docs = ["mdx-gh-links (>=0.2)", "mkdocs (>=1.5)", "mkdocs-gen-files", "mkdocs-literate-nav", "mkdocs-nature (>=0.6)", "mkdocs-section-index", "mkdocstrings[python]"]
testing = ["coverage", "pyyaml"]

and in a make file call it like

.PHONY: docs-test
docs-test: ## Test if documentation can be built without warnings or errors
	@poetry run mkdocs build -s

anything else to be done ?

[pawamoy]

usually I can write log output that way to text files.

In shell scripts yes, not in Python 🙂

---

With mkdocstrings[python] in your dependencies, and a recent lock file, this should install the new handler 👍
If that's the case, then the options you are using are outdated (they are for the legacy handler).

Try this instead:

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [..]

See the docs for the paths option: https://mkdocstrings.github.io/python/usage/#finding-modules.

I'll move this issue to a discussion since there's nothing actionable for MkDocs.