add file to build doc in /docs

[jburel]

Add file to build the Sphinx documentation in the folder /docs

[jburel]

Still need a bit of work!!

[jburel]

using secrets did not work!
without specifying the repo: https://github.com/jburel/omero-guide-python/actions/runs/366624466
with the repo set: https://github.com/jburel/omero-guide-python/actions/runs/366629648

[joshmoore]

You mean to push to another repository?

[jburel]

no this is only taking care of building the doc; in that case the directory specified is where the doc is located. Most repositories have the sphinx documentation under ./docs (default), this is not the case for a handful of repo, in that case we will have to specify where the doc is

[jburel]

I have tested this template against ome-documentation
https://github.com/jburel/ome-documentation/actions/runs/368187936
using

env: 
      directory_path: .
      check_link: false # set to false to remove linkcheck

[joshmoore]

A few minor comments but certainly nothing that needs addressing here.

[jburel]

@joshmoore I managed to simplify the way the action was setting the directory. It has to be done in 2 steps but it reduces the overall complexity

[jburel]

hold off on that one, still investigating to see if we can do things better

[jburel]

I looked at some sphinx actions, it works fine for repo like the guides but not for our doc repo due.
This template can be used in all the repos, so I will leave it as it is.

[joshmoore]

Few minor comments but generally looks good. 👍

[jburel]

with clean html linkcheck: https://github.com/jburel/omero-guide-python/actions/runs/393683967
with clean html: https://github.com/jburel/omero-guide-python/actions/runs/393686923
This approach will allow more flexibility

[sbesson]

The last option is a good compromise between sensible default commands and flexibility.

[jburel]

merging so I can roll it out across repositories