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

Replace `ruamel.yaml` with `PyYAML` and Cleanup Imports #73

Closed tasansal closed 11 months ago

tasansal commented 11 months ago

Closes #70.

  1. Replaced ruamel.yaml with pyyaml since it comes with MkDocs.
  2. Added and applied isort to sort imports
  3. Cleaned up unused imports

I tested it with my documentation, seems to work exactly the same. However not sure how to run your tests.

May I suggest (for the future):

  1. Migrate to pyproject.toml from setup.py
  2. Writing a contributor guide
  3. Implement minimal linting (black + flake8)
  4. Automated tests
JakubAndrysek commented 11 months ago

Thanks much for your quick work. I agree with all your future requests. If you have time I will be glad to merge your pull request. Have a nice day.