etiennebacher / altdoc

Alternative to pkgdown to document R packages
https://altdoc.etiennebacher.com
Other
65 stars 9 forks source link

Clean mkdocs #117

Closed etiennebacher closed 10 months ago

etiennebacher commented 10 months ago

Close #113 Close #114 Close #115

@vincentarelbundock can you check if python -m mkdocs works on your system?

netlify[bot] commented 10 months ago

Deploy Preview for upbeat-hamilton-47df84 ready!

Name Link
Latest commit 8f7512288edea572a455bf38e4f462618f8d38f1
Latest deploy log https://app.netlify.com/sites/upbeat-hamilton-47df84/deploys/655e00390a4b120008ff9fd4
Deploy Preview https://deploy-preview-117--upbeat-hamilton-47df84.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

vincentarelbundock commented 10 months ago

Can't test now, but on at least one of my machines I have the call python3

etiennebacher commented 10 months ago

That's annoying, I don't know how to check that mkdocs is installed on all OS

vincentarelbundock commented 10 months ago

Maybe we do our best to check, then try variations:

mkdocs run .... python mkdocs build... python3 mkdocs build...

then we catch errors and say something like "Did you install...?" and print the actual error message that we caught.

etiennebacher commented 10 months ago

Looks like python3 and python are just here because sometimes there's also a python v2 installation: https://superuser.com/questions/1440218/whats-the-difference-between-the-keywords-python-and-python3-in-command-lin

Using python3 -m everywhere should work.

The mkdocs workflow still doesn't work because of #116 though

vincentarelbundock commented 10 months ago

see my proposal in that other issue for a possible workflow.

etiennebacher commented 10 months ago

This PR doesn't actually change the workflow, just makes mkdocs errors pop up earlier in the process if mkdocs is not here, so I'll merge it now