Set markdown format via __docformat__ or command line --docformat

[peterjc]

I note that pdoc3 supports pure Markdown (with extensions), numpydoc, and Google-style docstrings formats, and you have partial reStructuredText support (see #110).

I do not see that you allow explicit declaration of which markup language (or flavour) is being used, although I see internally variable docformat can be "numpy" or "google".

I would like to be able to set a default at the command line with --docformat ... and/or override this at individual file level using__docformat__ = "..." as done in epydoc. See also rejected PEP258:

https://www.python.org/dev/peps/pep-0258/#choice-of-docstring-format
http://epydoc.sourceforge.net/manual-usage.html

Cross reference mitmproxy/pdoc#153 on the original pdoc project, and #158 on enabling markdown extensions.

[kernc]

Happy to change default param value to docformat=None and infer either supported format ('numpy' or 'google') from the passed module.obj.__docformat__, if available.

pdoc/pdoc/html_helpers.py

Lines 378 to 379 in b8758dd

	def to_html(text: str, docformat: str = 'numpy,google', *,
	module: pdoc.Module = None, link: Callable[..., str] = None,

Shouldn't be hard at all. PR welcome.

---

Not so thrilled about the CLI switch. What case doesn't work for you that you wanted to limit to either 'numpy' or 'google'?

[peterjc]

Personally I want to use --docformat restructuredtext at the command line (RST spelt out in full to match the convention established by epydoc).

[kernc]

This should now work.

To set it from the command line, one can use: pdoc --config='docformat="numpy"' ...

Whether to support reStructuredText, and how, is a different issue (#110).