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.

Sign up for GitHub

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

Jump to bottom

Automate GH Pages build #28

Draft
wants to merge 35 commits into
base: main
Choose a base branch
from
Draft

Automate GH Pages build #28

wants to merge 35 commits into from

Conversation

CasperWA
Copy link
Contributor

This PR should ideally close #19.

It will automatically extract the version numbers for each ontology file, compile and build the GH pages files and push them to the gh-pages branch.

@CasperWA CasperWA added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 23, 2021
@CasperWA CasperWA mentioned this pull request Apr 23, 2021
Closed
jesper-friis
jesper-friis reviewed Apr 25, 2021
View reviewed changes
Copy link
Collaborator

@jesper-friis jesper-friis left a comment

Choose a reason for hiding this comment

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

Looks fine. But I wonder if it wouldn't make more sense to place the gh_pages/ folder in the root rather than in ontology/?

I will make a new issue about repo layout where we can discuss that further.

.github/workflows/gh_pages.yml Outdated Show resolved Hide resolved
ontology/gh_pages/requirements.txt Outdated Show resolved Hide resolved
@CasperWA CasperWA force-pushed the automate_gh-pages branch 2 times, most recently from a6f8bc8 to f2117d5 Compare August 18, 2021 13:10
@CasperWA CasperWA force-pushed the automate_gh-pages branch 2 times, most recently from 05c14b0 to 0d50674 Compare December 9, 2021 13:03
CasperWA and others added 20 commits August 19, 2022 09:46
@CasperWA
Scaffold for automating GH Pages build
444927f
@CasperWA
Update versions
9843053
@CasperWA
Run pre-commit
25a9bac
@CasperWA
Update .gitignore
5eb2920
@CasperWA
Use SINTEF/ci-cd for workflows
02f0b71
@CasperWA
Minor fix to workflow value
7df2998
@CasperWA
Update pre-commit hooks, add isort
b3e5a40 
Remove pylint configuration from pyproject.toml
@CasperWA
Running isort and updating with black max line len
6815d16
@CasperWA
Update pylint disable statements in codebase
649d226
@CasperWA
Fix typo
0d274d4
@CasperWA
Add Word to DDL and create full cif-core ontology
4939fd0
@CasperWA
Remove auto-generated catalog file
beaa794
@CasperWA
Fallback to online DDL ontology
5c98deb
@CasperWA
Add new MkDocs framework documentation
589a5b4
@CasperWA
Add documentation landing page
e403a5a
@CasperWA
Update documentation with proper links
cba0d38
@CasperWA
Beginning version release overview docs page
fcdbb96
@CasperWA
Create _utils.py to hold utility elements
9cb4e3b
@CasperWA
Don't add private module to API docs
02944b3
@CasperWA
Implement auto-generation when building docs
f01a711 
Auto-generate ontologies in `ontology/` when building the documentation
and place them under the `docs/ontology/versions/` folder.

NB! Currently, the previous versions are not kept, as everything under
the `docs/ontology/versions/` folder is ignored by git.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jesper-friis jesper-friis jesper-friis left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Publish current CIF ontology
2 participants
@CasperWA @jesper-friis