Changes

Jump to navigation Jump to search
m
no edit summary
Line 74: Line 74:  
         return row[0]</pre>
 
         return row[0]</pre>
   −
5.  '''Proofread'''.  Use the 'make-doc.sh' script to build the docs.  Then ''cd doc/_build/html'' and start a http server (''python -m SimpleHTTPServer 8000'').  Load 'localhost:8000'' in your favorite web browser and check that your documentation has rendered correctly and makes sense.  Make sure you have a spell checker in your text editor (the vim one in very nice as it only checks strings and docstrings), because I can't spell or check.
+
5.  '''Proofread'''.  Use the 'make-doc.sh' script to build the docs.  Then ''cd doc/_build/html'' and start a http server (''python -m SimpleHTTPServer 8000'').  Load ''localhost:8000'' in your favorite web browser and check that your documentation has rendered correctly and makes sense.  Make sure you have a spell checker in your text editor (the vim one in very nice as it only checks strings and docstrings), because I can't spell or check.
    
[[User:SAMdroid|SAMdroid]] ([[User talk:SAMdroid|talk]]) I'm being hypocritical saying this, but I'll proof it soon :)
 
[[User:SAMdroid|SAMdroid]] ([[User talk:SAMdroid|talk]]) I'm being hypocritical saying this, but I'll proof it soon :)
   −
6.  Write a commit message like ''Write documentation for sugar3.i.just.wrote.docs''.
+
6.  Write a commit message like ''Write documentation for sugar3.path.module''.
    
7.  Create a pull request on GitHub.
 
7.  Create a pull request on GitHub.
Line 92: Line 92:  
reStructuredText primer:  http://sphinx-doc.org/rest.html
 
reStructuredText primer:  http://sphinx-doc.org/rest.html
   −
how do I go X in sphinx?:  I'm too lazy to find docs.  Just duckduckgo or google "sphinx X" if you haven't already.
+
How do I do X in sphinx?:  I'm too lazy to find docs.  Just duckduckgo or google "sphinx X" if you haven't already.

Navigation menu