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

publish documentation from GitHub Actions workflow #953

Closed
prjemian opened this issue Dec 10, 2021 · 1 comment · Fixed by #955
Closed

publish documentation from GitHub Actions workflow #953

prjemian opened this issue Dec 10, 2021 · 1 comment · Fixed by #955

Comments

@prjemian
Copy link
Contributor

Following #663 and related (nexusformat/wiki#4, #702, #868), the documentation built by a jenkins workflow running on a server at STFC-ISIS is published to the GitHub pages web site (reserved by GitHub) for the definitions repository. That GitHub pages site, where the documentation is published, redirects to our manual.

https://nexusformat.github.io/definitions redirects now to https://manual.nexusformat.org/

Recently, it has become quite simple to build and publish a repository to its gh-pages web site using a GitHub Actions workflow (and is supported by Sphinx), such as this example from the apstools repository.

Our syntax checking workflow already builds the documentation with various Python versions. An additional step (or a separate workflow) could publish after a successful build. We could add restrictions that would only publish based on criteria, such as pushes to the main branch.

It is proposed to add such a workflow here, which would let us retire the service provided by ISIS (and detect problems such as #946 as they occur). We could publish based on criteria, such as pushes to the main branch.

@prjemian prjemian added this to the NXDL 2021.10 milestone Dec 10, 2021
prjemian added a commit that referenced this issue Dec 10, 2021
prjemian added a commit that referenced this issue Dec 10, 2021
prjemian added a commit that referenced this issue Dec 10, 2021
prjemian added a commit that referenced this issue Dec 10, 2021
prjemian added a commit that referenced this issue Dec 10, 2021
prjemian added a commit that referenced this issue Dec 10, 2021
prjemian added a commit that referenced this issue Dec 10, 2021
prjemian added a commit that referenced this issue Dec 10, 2021
prjemian added a commit that referenced this issue Dec 10, 2021
prjemian added a commit that referenced this issue Dec 10, 2021
prjemian added a commit that referenced this issue Dec 10, 2021
prjemian added a commit that referenced this issue Dec 10, 2021
@prjemian
Copy link
Contributor Author

The GitHub Actions workflow log demonstrates that the workflow is successful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment