pygobject / pgi-docgen

API Documentation Generator for PyGObject
https://lazka.github.io/pgi-docs/
GNU Lesser General Public License v2.1
128 stars 36 forks source link

A bit of doc update, and HarBuzz built from source example #172

Open HinTak opened 5 years ago

HinTak commented 5 years ago

The "gir-1.0" is not obvious - I needed to run strace to figure that out.

HinTak commented 5 years ago

I want to write a bit about virtualenv also, please don't pull yet.

HinTak commented 5 years ago

I can't seem to figure out how to do `pwd` (for the pythonpath part), but this is all I wanted to write. Please review and pull.

lazka commented 5 years ago

somewhat related: I've filed #173

HinTak commented 5 years ago

Actually pgi-docgen's installation was not not too bad. I was reluctant to run tools/bootstrap.sh for a long time fearing it would download lots of stuff. It only put about 20MB on my hard disk.

Running it was more an issue - as you saw, it took me a bit of time to figure out how to regenerate HarfBuzz's doc from dev source (after I made some gobject annotation changes); the cert package situation was curious though understandable - the packager wants you to use the code but not the bundled certificates (which can get out of date). I also was not expecting it to recurse through my system's GIR directory and regenerating dependent packages' docs when I only asked for one.

As far as this pull goes, I think your only objection is the pythonpath one? I think it is not ideal either, and I like to figure out what's wrong if there is any tips in looking into that.

HinTak commented 3 years ago

Apologies, been a while. I'll come back to this and see if there is any more work to be done soon...