UPPMAX / HPC-python

https://uppmax.github.io/HPC-python
https://uppmax.github.io/HPC-python/
7 stars 2 forks source link

Get the link checker and spell checker working #8

Closed bclaremar closed 6 months ago

bclaremar commented 6 months ago

Can you @richelbilderbeek please help us. It never checks the whole tree. I have tested the settings from docs pages, and progform and R-python-julia courses pages without success!

bclaremar commented 6 months ago

I cannot figure out why the spelling worked once but not after that!

richelbilderbeek commented 6 months ago

I cannot figure out why the spelling worked once but not after that!

@bclaremar: Is it the link checker (from the title) or the spelling checker (from this comment) or both not working?

bclaremar commented 6 months ago

both!

richelbilderbeek commented 6 months ago

Spellchecker seems to works:

richel@richel-N141CU:~/GitHubs/HPC-python$ pyspelling -c .spellcheck.yml
Spelling check passed :)

and when adding errors to README:

richel@richel-N141CU:~/GitHubs/HPC-python$ pyspelling -c .spellcheck.yml
Misspelled words:
<htmlcontent> README.md: html>body>p
--------------------------------------------------------------------------------
aelrguWBEPFEUIP
--------------------------------------------------------------------------------

!!!Spelling check failed!!!

Could break spelling CI script by pushing the error.

richelbilderbeek commented 6 months ago

Conclusion: spellchecker worked and works :+1:

richelbilderbeek commented 6 months ago

Link checker works:

Screenshot from 2024-05-15 17-45-47

richelbilderbeek commented 6 months ago

@bclaremar both tools work perfectly! To be precise: both tools work perfectly on Markdown and on the markdown pages in this repo.

However, as this page is written in ReStructuredText, one needs other CI tools. I don't know which these are.

That concludes my research :+1: