Doc: typo & tips

[YDX-2147483647]

• Fix typo.

• Update the .vscode/settings.json example in CONTRIBUTING.md.

  Venv uses bin on POSIX, but Scripts on Windows.

• Some tests won't pass without requirements/documentation.txt.

  See also: 4b1cfd adds documentation.txt into GitHub Actions.

  For example, test_simple_build in tests/test_build.py builds mkdocs.yml,
  and its theme (mkdocs-bootswatch/united) is not covered in
  requirements/development.txt.

  theme:
    name: united

[Guts]

Thank for this PR cleaning up the dust!

Some tests won't pass without requirements/documentation.txt.

Oh damn! It's not the expected at all! feel free to fix that by switching to a default theme.

[codecov]

Codecov Report

Merging #179 (9b81eb1) into main (592956a) will decrease coverage by 0.06%.
The diff coverage is n/a.

❗ Current head 9b81eb1 differs from pull request most recent head e38ab72. Consider uploading reports for the commit e38ab72 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #179      +/-   ##
==========================================
- Coverage   79.79%   79.74%   -0.06%     
==========================================
  Files           7        7              
  Lines         396      395       -1     
  Branches       91       91              
==========================================
- Hits          316      315       -1     
  Misses         52       52              
  Partials       28       28              

see 1 file with indirect coverage changes

[YDX-2147483647]

feel free to fix that by switching to a default theme.

Uhh, it might be difficult… The following test uses mkdocs.yml in project root (outside tests/fixtures/), which is the theme for our docs.

mkdocs-rss-plugin/tests/test_build.py

Lines 70 to 84 in 769744e

	def test_simple_build(self):
	with tempfile.TemporaryDirectory() as tmpdirname:
	cli_result = self.build_docs_setup(
	testproject_path="docs",
	mkdocs_yml_filepath=Path("mkdocs.yml"),
	output_path=tmpdirname,
	strict=False,
	)
	if cli_result.exception is not None:
	e = cli_result.exception
	logger.debug(format_exception(type(e), e, e.__traceback__))
	self.assertEqual(cli_result.exit_code, 0)
	self.assertIsNone(cli_result.exception)

mkdocs-rss-plugin/mkdocs.yml

Lines 37 to 38 in 769744e

	theme:
	name: united

We can apply the .env + !ENV [MKDOCS_THEME, 'mkdocs'] trick, but is it really worth?

What do you think?

[YDX-2147483647]

Hi, shall I replace test_simple_build with a new mkdocs.yml, or modify mkdocs.yml in the project root? Which do you prefer?

[Guts]

Sorry for the delayed answer.

Hi, shall I replace test_simple_build with a new mkdocs.yml, or modify mkdocs.yml in the project root? Which do you prefer?

Replace test_simple_build with a new mkdocs.yml

[YDX-2147483647]

No worries, we all have our own lives.

---

I've just implemented it and tested locally. Could you run the ci?

[Guts]

Perfect!

Let's merge it!

I'm waiting for #177 to release a new version.