Closed gozat closed 3 years ago
Ok, I completely messed everything up. After scratching my head quite a while on the doc, pne cannot use options -m
, -I
or -p
with a pydoc-markdown.yml
configuration file.
Instead use
loaders:
- type: python
packages: [name_of_the_package1, name_of_the_package_2,] # in a list of strings
search_path: [directory1, directory2, ..] # in a list of strings
processors:
- type: filter
skip_empty_modules: false
exclude_private: false
exclude_special: false
- type: smart
- type: crossref
renderer:
- type:markdown
and then run
pydoc-markdown > test.md
in the root directory of your package. I assume you followed the official documentation on creating Python package.
Hope this might help others !
My
pydoc-markdown.yml
file :but the privates methods do not show up in the final markdown file (all other methods and functions print correctly). Is that normal ?
The bash command :
Version 3.5.0