diff --git a/README.md b/README.md index 8a0b0bc..929215f 100644 --- a/README.md +++ b/README.md @@ -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/). diff --git a/docs/dev_notes.md b/docs/dev_notes.md index 14f4e4f..e0ebbf0 100644 --- a/docs/dev_notes.md +++ b/docs/dev_notes.md @@ -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 \ No newline at end of file