search

JakubAndrysek / MkDoxy

📖 Automatically generates API documentation for your project based on Doxygen comments and code snippets in your markdown files.
https://mkdoxy.kubaandrysek.cz/
MIT License
60 stars 16 forks source link

`ruamel.yaml` missing from runtime dependencies #70

Closed tasansal closed 11 months ago

tasansal commented 11 months ago

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.

asherban commented 11 months ago

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

tasansal commented 11 months ago

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 commented 11 months ago

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

Thanks