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

Fix(update-readme) #130

Merged
merged 4 commits into from
May 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Since the beginning of the century, research on ontology learning has gained popularity. Automatically extracting and structuring knowledge relevant to a domain of interest from unstructured data is a major scientific challenge. We propose a new approach with modular ontology learning framework considering tasks from data pre-processing to axiom extraction. Whereas previous contributions considered ontology learning systems as tools to help the domain expert, we developed the proposed framework with full automation in mind.

Resources:

- The documentation is available here: [OLAF](https://wikit-ai.github.io/olaf/index.html)
- [Poster](./docs/Poster_OLAF_2023.pdf)
- Our research paper has been published at [KES 2023](http://kes2023.kesinternational.org/).

Expand Down
13 changes: 8 additions & 5 deletions docs/dev_notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,8 +281,11 @@ Generate documentation :
- generate sphinx markdown `sphinx-apidocs -o docs olaf/`
- and then generate html pages `cd docs && make html`

Update documentation hosted with github-pages :

- move to gh-pages `git checkout gh-pages`
- rebase gh-pages to the main `git rebase main`
- and then push `git push origin gh-pages`
To host the documentation with with github-pages :

- create a branch named `gh-pages`
- enable github pages and set the working branch as `gh-pages`
- create an acces-token
- add an environment secret named `TOKEN` with the generated acces token as value
- add an environment variable called `USER_MAIL` with your email address as value
- add an environment variable called `USER_NAME` with your github username as value