Documentation: accessing documentation in offline mode

[exiledonamarginalisland]

I would like to be able to access the documentation in offline mode when I am in areas where I have no connection. What do I have to do? Is there a way of installing ghini that includes the documentation?

[mfrasca]

please confirm that you have read a minimal tutorial about sphinx. when you do a devinstall.sh installation, you have everything but the translated docs. "everything" includes the documentation. then producing the documentation locally is a matter of running the sphinx Makefile.

[mfrasca]

less briefly:

• I assume you're using an operating system (Linux, or OSX)
• you need to have run devinstall.sh
• you need to have installed sphinx and that it be available from the ghide virtual environment. (in practice, install sphinx within ghide.)
• cd ~/Local/github/Ghini/ghini.desktop/doc/
• source ~/.virtualenvs/ghide/bin/activate
• make html (or make singlehtml, or make <tab> and choose by yourself).

there you are.

(but you could also use readthedocs and download it in ePub, PDF, or html)

[mfrasca]

I think that the 'download it from readthedocs' is a viable answer. you're always welcome with a different solution via a pull request. ciao, grazie.

[exiledonamarginalisland]

Thank you for the explanation. I think the issue I am facing is that when I install sphinx in ghide, I get the following error:

Not sure what I am doing wrong. Any clue?

[mfrasca]

I still think that your (and any casual user's) best bet is to download the formatted docs from readthedocs. if you want to help, try to remove the version specification in ghini pyparsing dependency and let me know. thank you.