search

timothycrosley / portray

Your Project with Great Documentation.
MIT License
861 stars 74 forks source link

Custom "output_dir" ignored in pyproject.toml config #63

Closed kyluca closed 3 years ago

kyluca commented 3 years ago

Hey,

I've been looking into using portray for a project recently and stumbled on what I think is a bug, unless I've misread the docs and got my config wrong (which is entirely possible! :joy:). Using a minimal pyproject.toml config, I wanted to specify a custom "output_dir" but when I ran portray it appeared to ignore it:

Contents of pyproject.toml

...
[tool.portray]
modules = ["my_module"]
output_dir = "docs_output"
...

Output

$ portray as_html --overwrite
...
Documentation successfully generated into `/path/to/my/repos/my_module/site` !

I believe this is a bug because using a CLI override instead does work as desired (but I'd prefer to save it in a config file):

$ portray as_html --overwrite --output_dir docs_output
...
Documentation successfully generated into `/path/to/my/repos/my_module/docs_output` !

I'd love to take a closer look and submit a PR for Hacktoberfest if you don't mind?

Cheers, Kyle