lakka  committed 8ebf3e0 Draft

Edited online

  • Participants
  • Parent commits 32abd00

Comments (0)

Files changed (1)

 = Welcome =
-Welcome to your wiki! This is the default page we've installed for your convenience. Go ahead and edit it.
+This repository is a clone of the [[|main PyObjC repository]] maintained by Ronald Oussoren, intended to allow me (or anyone else) to hack on the documentation. I hope that the documentation changes will eventually be pulled back into Ronald's repository.
-== Wiki features ==
+In line with that purpose, most of the changes here will be to the /pyobjc-core/Doc directory
-This wiki uses the [[|Creole]] syntax, and is fully compatible with the 1.0 specification.
-The wiki itself is actually a mercurial repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will be live immediately.
-Go ahead and try:
+To build the docs, you will need to have [[|Sphinx]] installed, and then execute
-$ hg clone
+make html
-Wiki pages are normal files, with the .wiki extension. You can edit them locally, as well as creating new ones.
-== Syntax highlighting ==
-You can also highlight snippets of text, we use the excellent [[|Pygments]] library.
-Here's an example of some Python code:
-def wiki_rocks(text):
-    formatter = lambda t: "funky"+t
-    return formatter(text)
-You can check out the source of this page to see how that's done, and make sure to bookmark [[|the vast library of Pygment lexers]], we accept the 'short name' or the 'mimetype' of anything in there.
-Have fun!
+in the pyobc-core/Doc directory