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

add file to build doc in /docs #9

Merged
merged 13 commits into from
Dec 8, 2020
Merged

add file to build doc in /docs #9

merged 13 commits into from
Dec 8, 2020

Conversation

jburel
Copy link
Member

@jburel jburel commented Nov 12, 2020

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

@jburel
Copy link
Member Author

jburel commented Nov 16, 2020

Still need a bit of work!!

@jburel
Copy link
Member Author

jburel commented Nov 16, 2020

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
Copy link
Member

You mean to push to another repository?

@jburel
Copy link
Member Author

jburel commented Nov 16, 2020

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
Copy link
Member Author

jburel commented Nov 17, 2020

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

Copy link
Member

@joshmoore joshmoore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

workflow-templates/sphinx.yml Show resolved Hide resolved
workflow-templates/sphinx.yml Outdated Show resolved Hide resolved
workflow-templates/sphinx.yml Outdated Show resolved Hide resolved
@jburel
Copy link
Member Author

jburel commented Nov 18, 2020

@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
Copy link
Member Author

jburel commented Nov 19, 2020

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

@jburel
Copy link
Member Author

jburel commented Nov 26, 2020

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.

Copy link
Member

@joshmoore joshmoore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few minor comments but generally looks good. 👍

workflow-templates/sphinx.yml Outdated Show resolved Hide resolved
workflow-templates/sphinx.yml Outdated Show resolved Hide resolved
@jburel
Copy link
Member Author

jburel commented Dec 1, 2020

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

Copy link
Member

@sbesson sbesson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@jburel
Copy link
Member Author

jburel commented Dec 8, 2020

merging so I can roll it out across repositories

@jburel jburel merged commit d3e767c into ome:master Dec 8, 2020
@jburel jburel deleted the docs_check branch March 22, 2022 10:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants