163
edits
Changes
Features/Sugar3 Docs/How To Write (view source)
Revision as of 02:10, 17 November 2015
, 02:10, 17 November 2015→Syntax Information: Fix formatting of newlines
5. '''Proofread'''. Use the 'make_docs.sh' 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_docs.sh' 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 :)
6. Write a commit message like ''Write documentation for sugar3.i.just.wrote.docs''.
6. Write a commit message like ''Write documentation for sugar3.i.just.wrote.docs''.
Napolean quick intro: http://sphinxcontrib-napoleon.readthedocs.org/en/latest/
Napolean quick intro: http://sphinxcontrib-napoleon.readthedocs.org/en/latest/
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 go X in sphinx?: I'm too lazy to find docs. Just duckduckgo or google "sphinx X" if you haven't already.