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

ruamel.yaml missing from runtime dependencies #70

Closed
tasansal opened this issue Jul 17, 2023 · 3 comments · Fixed by #73
Closed

ruamel.yaml missing from runtime dependencies #70

tasansal opened this issue Jul 17, 2023 · 3 comments · Fixed by #73

Comments

@tasansal
Copy link

Hi, came here after doxybook2 got archived! Your project looks very promising.

I was just trying to use it an realized ruamel YAML is a dev dependency but not a runtime dependency; which fails if just pip installed.

To replicate:

  1. pip install mkdoxy
  2. pip install mkdocs
  3. Configure mkdocs to use mkdoxy
  4. Run mkdocs build

Traceback:

File "/Users/.../.venv/lib/python3.11/site-packages/mkdoxy/utils.py", line 5, in <module>
    from ruamel.yaml import YAML
ModuleNotFoundError: No module named 'ruamel'

I can make a PR if needed.

@tasansal tasansal changed the title ruamel YAML missing from runtime dependencies ruamel.yaml missing from runtime dependencies Jul 17, 2023
@asherban
Copy link
Contributor

I suggest instead of adding ruamel as a dependency, switching to PyYAML which is imported by mkdocs.

@tasansal
Copy link
Author

tasansal commented Jul 18, 2023

I agree, maybe if I have some time I can modify my PR. Unless @JakubAndrysek has a specific reason to use ruamel, we should move to PyYAML.

@JakubAndrysek
Copy link
Owner

Yes, I agree.
Could you please create the PR with PyYAML.

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants