srvk
Documentation troubles
Some information have been duplicated in the documentation. I'm pretty sure something went wrong during a merge, leading to a documentation containing both an old version, and a new one.
Now that I updated the evaluation part, could you clean up the documentation (docs/source/usage.md is the only abnormal file) by removing everything that is outdated ?
Some paragraphs contain substantially the same information, and I'm not always sure which one is the most recent one. It shouldn't take more than 5 minutes !
Who has access to the build process for the readthedocs documentation and could rebuild it?
I have made many changes and updates to the documentation in the repository, but it is not reflected in the online version.
For reference, if someone successfully built DiViMe, they will have access to the complete and up-to-date documentation at DiViMe/docs/build/html/index.html, but that does not help a person trying to install the VM in the first place.
I believe this is done automatically but not instantaneously. Copying Julien, who helped me last time I had the same problem.
On Wed, Jul 3, 2019 at 11:28 AM Florian Metze [email protected] wrote:
Who has access to the build process for the readthedocs documentation and could rebuild it?
I have made many changes and updates to the documentation in the repository, but it is not reflected in the online version.
For reference, if someone successfully built DiViMe, they will have access to the complete and up-to-date documentation at DiViMe/docs/build/html/index.html, but that does not help a person trying to install the VM in the first place.
— You are receiving this because you modified the open/close state. Reply to this email directly, view it on GitHub https://github.com/srvk/DiViMe/issues/113?email_source=notifications&email_token=ABY6PHKTYLLR7X2CXBDGOFDP5TAQTA5CNFSM4GWQ5GE2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODZE2E5Y#issuecomment-508142199, or mute the thread https://github.com/notifications/unsubscribe-auth/ABY6PHPWF6QSNFVHP3NQCA3P5TAQTANCNFSM4GWQ5GEQ .
I checked the readthedocs, it seems that everything is up to date with the docs ..? Just in case I rebuilt it , but it looks like the latest commits regarding the doc are taken into account. There's a typo though, on the usage page, first line : "This is an overview of the full tool presentation found in the next sextion,[...]"
I added "fmetze" to maintainers of the doc on ReadTheDoc, but can't add you Alex because you need an account on ReadTheDocs.
In case the doc seems to be failing again, one thing to do is on github: 1 on the project page, go to "Settings" 2 go to "Webhooks" 3 there should be one line that contains this: https://readthedocs.org/api/v2/webhook/divime/82210/ (push) Check that it has a green "check" beside it and click on it 4 look at " Recent Deliveries", check that the date of the last delivery is indeed the date of your commit, and click on it 5 click on " redeliver" 6 wait a bit (maybe 10 minutes) and check if the doc is up to datet
Also, try hitting ctrl+f5 (windows/linux) or Maj + ⌘+R (mac), maybe you don't see the modification because your browser is displaying a cached version of the page and not the updated one.