[Twisted-Python] building offline docs
Sorry, more questions... Unfortunately, most of the time I have for learning and research is offline. How can I build the docs for browsing (html) from a subversion checkout? Chris -- Simplistix - Content Management, Batch Processing & Python Consulting - http://www.simplistix.co.uk
On March 12, 2014 at 5:45:09 PM, Chris Withers (chris@simplistix.co.uk) wrote: Sorry, more questions... Unfortunately, most of the time I have for learning and research is offline. How can I build the docs for browsing (html) from a subversion checkout? Twisted trunk is now a fairly standard sphinx-based project. “cd docs; make html” (assuming all the usual sphinx/twisted dependencies are available). -- Christopher Armstrong http://twitter.com/radix http://wordeology.com/
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Hi, There's two kinds of docs, both of which can be built with premade scripts. The api docs require pydoctor, the prose requires Sphinx (1.2 or later). Build the api docs with `./bin/admin/build-apidocs . apidocs/` and the sphinx docs with `./bin/admin/build-docs .` - this will put them both in the Twisted checkout, under apidocs/ and doc/ folders respectively. - -hawkowl On 13/03/14 06:47, Christopher Armstrong wrote:
On March 12, 2014 at 5:45:09 PM, Chris Withers (chris@simplistix.co.uk) wrote: Sorry, more questions...
Unfortunately, most of the time I have for learning and research is offline.
How can I build the docs for browsing (html) from a subversion checkout?
Twisted trunk is now a fairly standard sphinx-based project. “cd docs; make html” (assuming all the usual sphinx/twisted dependencies are available).
-- Christopher Armstrong http://twitter.com/radix http://wordeology.com/
_______________________________________________ Twisted-Python mailing list Twisted-Python@twistedmatrix.com http://twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-python
-----BEGIN PGP SIGNATURE----- Version: GnuPG v1 iQEcBAEBAgAGBQJTIO9uAAoJECMItHnTkkoReq0H/3r0AeEHT4pvsrXZ2jzVsE3U eeKjsjpcu2JTQzyHrEeFpS/zjr0FzKzoVgt7FUZTp30YwgGA3+7VDiLCYs/zOneA TPq/ySFpqmu/5J6EQqiq90fRhF30dMNN+bWLKAysPOqHrNiVmyy9uc2IsdVNnr68 /vNV96XMfxan3TJMEIX38v8VTTc56fcWHFPCighuplXhTaqcyShvLWbgWwVemAS+ VTRrTAAbCiEz9TvNnNsKl+9ryjwe+G6mRSibcE1Haez8PK+Ar48hfEjPia+7soHm rPUjk5N2MSgFAn9oczp8wyI2pKX61oHxZfJPkF9UNnzsn3eTpHI1A2GH+uzxVTc= =G9ar -----END PGP SIGNATURE-----
participants (3)
-
Chris Withers -
Christopher Armstrong -
HawkOwl