Test building docs in PRs #125
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update according to BIG-MAP/LabNotebookAppOntology.
Finalize build script. One can build the documentation simply by running python docs/scripts/build.py site It will then be built in the 'site' folder at the root of the repository. It utilizes the md_to_html.py script to generate HTML from all markdown files in the 'docs' folder and sub-folders (excluding any files found in 'assets', 'css', and 'scripts').
Update CI/CD workflows
Also ensure all requirements are installed for CI
Update and add documentation for how to release a new BattINFO version as well as how to release the documentation.
Slightly alter the `doc.yml` ("Sphinx: Render docs") CI workflow to run
on pull requests as well, but only ever deploy if pushing to the
'master' branch.
CasperWA
added
documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #124
This is mainly (as stated in the issue) to ensure any changes or package dependency updates do not make building the documentation fail.
Main changes:
doc.yml("Sphinx: Render docs") workflow for pull requests.Ensure the final "Deploy" step is only ever run when pushing to the 'master' branch.
doc.ymlworkflow to arequirements_docs.txtfile.The main motivation here is that Dependabot can read such a file and check if there are new updates to the dependencies here.
Also, the (now unused)
Markdowndependency has been removed..gitignorefile to ensure Python-generated cache files are not committed to the repository.Also ignore the standard target folder for the markdown/MkDocs documentation build (
site/).requirements.txtfile.All other changes are minor syntax changes (like removing unnecessary white space, etc.)
These changes can be reverted without any actual effect (other than a possible decline in readability and unnecessary bloating of file size).
As a comment: If you've moved away from using markdown/MkDocs, I suggest to remove the (now seemingly unused)
docsfolder. Just to clean up the repository a bit.I can do this in this PR, which will result in me also removing the
siteline in the.gitignorefile?As another note, I would assess and merge this PR before merging the PRs from Dependabot that update the package dependencies - mainly due to the fact that this PR introduces the documentation build test for PRs.