search

spatialmodel / inmap

InMAP reduced-form air quality model for fine particulate matter (PM2.5)
GNU General Public License v3.0
61 stars 42 forks source link

docs: Fix links between docs files #66

Closed karldw closed 5 years ago

karldw commented 5 years ago

This PR fixes links in the Github README.md and in the "see also" sections of the docs on the inmap.run site. For example, on https://inmap.run/docs/cmd/inmap_grid/#see-also, the link points to https://inmap.run/docs/cmd/inmap_grid/inmap but should point to https://inmap.run/docs/cmd/inmap

I haven't generated new HTML from these edits, but I'd be happy to if you tell me how.

coveralls commented 5 years ago

Coverage Status

Coverage remained the same at 67.327% when pulling 874fac703cf151f49cf45e2016f2438bdc735b57 on karldw:master into a0857d8748df3bb5faf5f72d41f296e837a71033 on spatialmodel:master.

ctessum commented 5 years ago

Thanks!

To regenerate the HTML files, run make docusaurus ; make update ; make clean in the website directory. If it's a hassle, though (because it requires 'make' and docker to be installed), I can just do it.

The markdown documents in the docs/cmd are automatically generated, so those changes will get overwritten the next time that happens, but hopefully we'll figure out a way to automatically add the changes back in.

karldw commented 5 years ago

Hmm, I have docker and make, and I'm able to run those make commands without any obvious errors, but it doesn't look like the HTML changed.

ctessum commented 5 years ago

Thanks for this. I will fix the problem with the website generation in another PR.