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

Documentation on module usage #185

Closed
keski opened this issue Mar 22, 2023 · 1 comment
Closed

Documentation on module usage #185

keski opened this issue Mar 22, 2023 · 1 comment

Comments

@keski
Copy link
Contributor

keski commented Mar 22, 2023

The documentation for use as a module seems to be a bit outdated.

# Module Use

from pylode import OntDoc

# initialise
od = OntDoc(ontology="some-ontology-file.ttl")

# produce HTML
html = od.make_html()

# or save HTML to a file
od.make_html(destination="some-resulting-html-file.html")

In the current code base, shouldn't that be something like:

# Module Use

from pylode.profiles.vocpub import VocPub
# or from pylode.profiles.ontpub import OntPub

# initialise
od = VocPub(ontology="some-ontology-file.ttl")

# produce HTML
html = od.make_html()

# or save HTML to a file
od.make_html(destination="some-resulting-html-file.html")
hoijui added a commit to elevont/pyLODE that referenced this issue Jan 29, 2024
hoijui added a commit to elevont/pyLODE that referenced this issue Jan 29, 2024
hoijui added a commit to elevont/pyLODE that referenced this issue Feb 11, 2024
hoijui added a commit to elevont/pyLODE that referenced this issue Feb 11, 2024
hoijui added a commit to elevont/pyLODE that referenced this issue Mar 10, 2024
@nchauvat
Copy link

hi @edmondchuc and @nicholascar . Thank you for PyLODE. Is the project still actively maintained ? Looking at the commit history I would think it is, but I am surprised that an issue like this one has a MR that is not merged. Would you need help to review it ?

hoijui added a commit to elevont/pyLODE that referenced this issue May 18, 2024
hoijui added a commit to elevont/pyLODE that referenced this issue May 26, 2024
nicholascar added a commit that referenced this issue Jul 26, 2024
README: Update "Module use" docu [fix #185]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants