[python + travisCI] Automatically deploy and generate documentation

[yochannah]

HTML documentation for our library can be generated using the pydoc -w command.

It would be nice to use travis or github actions to automatically generate docs and deploy them to the gh-pages branch of this repo.

This should only happen for the master branch.

if you want to pick up this task

0. Take a look at the InterMine contributing guidelines
1. Comment on this issue stating that you intend to work on the task
2. When you're ready, add your work to the repo and create a pull request.

What to do if you need help

Mention @yochannah, tweet @yoyehudi, pop by to say hi on chat or if needed email [email protected]. Don't forget we're usually only available during uk office hours and will not be able to respond at other times :)

[biswajitpatra]

can i take this up?

[yochannah]

@biswajitpatra Go for it! 🚀

[yochannah]

Hey @biswajitpatra - did you ever get the chance to look at this? :)

[anmol27katyani]

Hello @yochannah , I just saw this issue and I looked up for how I can approach, and I found https://circleci.com/blog/deploying-documentation-to-github-pages-with-continuous-integration/
I will be taking help from the mentioned webpage to see how it is done. I know this is for Circleci and Intermine is using Travis at the moment, I would like to take this up and fix this.

[yochannah]

Hey @anmol27katyani ! That sounds fine, but one question- is Circle free for open source projects?

[edeediong]

@yochannah I'd love to pick up this issue.

Observations

1. I have a few questions from my observations. I noticed running a pydoc -w intermine just creates the intermine.html file for the folder. If you click any of the hyperlinks it throws an error because the pydoc didn't create HTML for each of the Python files in the folder. Shouldn't it run create HTML files for everything or am I running the command wrongly?
2. To auto-generate docs, when should the travis build run? Is it on every PR or Merge or when there's an update to the codebase? I'm still trying to wrap my head around when it should be run.

[yochannah]

@edeediong please go ahead!

1. Check out the readme - we have a slightly different command, pydoc intermine.query.Query that does what we need.
2. For travis - I think if you set up scripting so it can run the build every time, every PR/merge would be perfect. every change to master I think.