RFC: documentation browser



Hi,

I've been working on a documentation browser for documentation generated from GObject introspection files. Besides good old DevHelp on the desktop, there are several good online open-source documentation browsers that already exist, and one of them is DevDocs [1] which has lots of nifty features such as fuzzy search and storing documentation for offline use.

I have a branch of gobject-introspection [2] which modifies g-ir-doc-tool to generate docs that can then be imported by a branch of DevDocs [3]. Among the modifications to g-ir-doc-tool is a refactoring to give it an output format switch which I've already filed as bgo#750534 [4].

I've hosted an instance of the modified DevDocs on AWS [5]. This link is temporary, because at some point it'll start costing me money. I also have instructions [6] for how I set up DevDocs from a bare RHEL 7 install on AWS in case anyone wants to replicate it themselves.

If you're interested in this, please give it a try and let me know your thoughts and suggestions. I'm hoping to get more people interested in it, especially with the upcoming DX hackfest.

Currently this is just for _javascript_ docs. We already have decent C, Python, and Vala docs hosted elsewhere, but it wouldn't be too hard to modify this setup to include all four languages.

Best,
Philip C.

[1] http://devdocs.io/
[2] https://github.com/ptomato/gobject-introspection/tree/wip/ptomato/devdocs
[3] https://github.com/ptomato/devdocs/tree/gir-redux
[4] https://bugzilla.gnome.org/show_bug.cgi?id=750534
[5] http://ec2-52-32-237-163.us-west-2.compute.amazonaws.com:9292/
[6] https://gist.github.com/ptomato/f778f55c92ff52590c92



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]