Commits

Kevin Horn committed c7f02ae Merge

* merge

Comments (0)

Files changed (4)

 
     1. Get it:
         hg clone http://bitbucket.org/khorn/lore2sphinx
+
     2. Install with 'python setup.py install'
     
     3. Copy 'lore2sphinx.conf.default' to 'lore2sphinx.conf'
     
     5. Run bin/lore2sphinx. This will generate the rst files for Sphinx.
         - If the script can't find your lore2sphinx.conf file, use the '-c' option
-          to specify the config file's exact location
+          to specify the config file's exact location. Specify the '--help' command
+          to see all available options.
     
     6. Build the Sphinx project:
-        cd profiles/twisted/source
+        cd profiles/twisted
         make html
     
     7. Look at the output in build/html/ to see what's broken
     
-    8. Give feedback!
+    8. Give feedback! Open a ticket on Bitbucket or use the Twisted-Python mailinglist.

lore2sphinx.conf.default

 #
 # Also note that directories may be specified either with or without 
 # trailing backslashes.
+
 [twisted]
 
 # The 'lore_dir' setting is the directory where the lore source documents
-# to be converted exist.
+# to be converted exist, like /path/to/twisted/trunk/doc
 lore_dir = C:\Documents and Settings\hornk\Desktop\twisted-dev\doc\
 
 # The 'output_dir' setting is the directory to which Sphinx/ReST files

profiles/twisted/source/conf.py

 
 # General information about the project.
 project = u'Twisted'
-copyright = u'2001-2010, Twisted Matrix Labs'
+copyright = u'2001-2011, Twisted Matrix Labs'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # Base url for apilinks extension
 apilinks_base_url = 'http://twistedmatrix.com/documents/current/api/'
 traclinks_base_url = 'http://twistedmatrix.com/trac'
+
+# A list of regular expressions that match URIs that should
+# not be checked when doing a 'make linkcheck' build (since Sphinx 1.1)
+linkcheck_ignore = [r'http://localhost:\d+/']
         'Operating System :: OS Independent',
         'Framework :: Twisted',
         'Programming Language :: Python',
-        'Programming Language :: Python :: 2.5',
         'Programming Language :: Python :: 2.6',
+        'Programming Language :: Python :: 2.7',
         'Topic :: Software Development :: Libraries :: Python Modules',
     ]
 )
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.