search

RDFLib / pyLODE

An OWL ontology documentation tool using Python and templating, based on LODE
BSD 3-Clause "New" or "Revised" License
162 stars 70 forks source link

Documentation on module usage #185

Open keski opened 1 year ago

keski commented 1 year ago

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")
nchauvat commented 3 months ago

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 ?