Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation troubles #113

Open
MarvinLvn opened this issue Feb 11, 2019 · 4 comments
Open

Documentation troubles #113

MarvinLvn opened this issue Feb 11, 2019 · 4 comments
Assignees
Labels

Comments

@MarvinLvn
Copy link
Collaborator

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 !

@fmetze
Copy link
Contributor

fmetze commented Jul 3, 2019

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.

@alecristia
Copy link
Collaborator

alecristia commented Jul 3, 2019 via email

@jukaradayi
Copy link
Contributor

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

@jukaradayi
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants