Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs overritten when files have the same name under different folders #40

Closed
pauloburke opened this issue Sep 7, 2022 · 1 comment
Closed
Labels
bug Something isn't working stale Awaiting input from creator for prolonged time period

Comments

@pauloburke
Copy link

Describe the bug:

When using the function "generate_docs", if there are two files with the same name under different subpackages, (e.g. subpkg1/utils.py and subpkg2/utils.py), the docs generated for the second one will override the first "utils.py.md".

Expected behaviour:

Doc files are not to be overwritten.

Steps to reproduce the issue:

  1. Have the following folder structure:
    src/subpkg1/utils.py
    src/subpkg2/utils.py
  2. call generate_docs(["src/subpkg1/utils.py","src/subpkg2/utils.py"], "docs/")
  3. Only one "docs/utils.py.md" is generated.

Technical details:

  • Host Machine OS (Windows/Linux/Mac): Mac
  • Browser (Chrome/Firefox/Safari): Irrelevant

Possible Fix:

Maybe add an option to name the file with the subpackage name as prefix (e.g. "docs/subpkg1.utils.py.md" and "docs/subpkg2.utils.py.md")

@pauloburke pauloburke added the bug Something isn't working label Sep 7, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Dec 7, 2022

This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 14 days

@github-actions github-actions bot added the stale Awaiting input from creator for prolonged time period label Dec 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working stale Awaiting input from creator for prolonged time period
Projects
None yet
Development

No branches or pull requests

1 participant