Documentation

[alexvoss]

A couple of small changes to the documentation. Hope they make sense.

I would suggest more if you agree that they would be useful:

• tell people to use Python's built-in venv to create a virtual environment
• tell them about the PIP_REQUIRE_VIRTUALENV variable so they don't install everything into a global environment
• add the note about configuring the pytest --no-cov option when debugging. I can do this for VSCode.

Edit: could look a bit like https://squidfunk.github.io/mkdocs-material/customization/#environment-setup

[alexvoss]

I just realized that it might make sense to include the CONTRIBUTING.md into the documentation in the same way that README.md is. In that case the link fix may not be needed.

[codecov]

Codecov Report

Merging #207 (d8d896a) into main (89e9cfa) will increase coverage by 3.30%.
The diff coverage is 37.50%.

@@            Coverage Diff             @@
##             main     #207      +/-   ##
==========================================
+ Coverage   77.61%   80.91%   +3.30%     
==========================================
  Files           7        7              
  Lines         411      414       +3     
  Branches       89       97       +8     
==========================================
+ Hits          319      335      +16     
+ Misses         64       51      -13     
  Partials       28       28              

Files	Coverage Δ
mkdocs_rss_plugin/util.py	72.14% <37.50%> (+1.77%)	⬆️

... and 1 file with indirect coverage changes

[Guts]

Hi @alexvoss

Firstly thanks for your interest and taking time to make some PRs!

A couple of small changes to the documentation. Hope they make sense.

They do. Can you just remove changes to util.py please to make this PR focused on documentation?

I would suggest more if you agree that they would be useful:

• tell people to use Python's built-in venv to create a virtual environment
• tell them about the PIP_REQUIRE_VIRTUALENV variable so they don't install everything into a global environment
• add the note about configuring the pytest --no-cov option when debugging. I can do this for VSCode.

And please, feel free to propose theses changes too. In this same PR if you want this time 😉.

[alexvoss]

Ok, will do. I will scrap this PR as I have no idea how to rewrite Git history. I think I am too old for that.

[Guts]

Hello @alexvoss,

Since you're too old for cherry-picking or somewhat, I've use your small documentation improvements in my documentation refacto https://guts.github.io/mkdocs-rss-plugin/ and also in the readme.

YAMBWUM¹!

Can you check it if I've missed something and close here if everything is right?

Footnotes

1. Yet Another Mkdocs Based Website Using Material cc @squidfunk 😉 ↩

[Guts]

@alexvoss I'm closing here.
Don't hesitate to reopen if you feel that I've missed something.