@@ -91,8 +91,8 @@ and it is very easy to extends or add your own commands (see `paver documentation <http://www.blueskyonmars.com/projects/paver/>`_ for more details). -You are ready to write your package (in ``src/``) and its documentation -(in ``docs/source``). You should probably start tracking your project now:: +You are ready to write your package and its documentation +(in ``docs/``). You should probably start tracking your project now:: git init git add . @@ -126,7 +126,7 @@ and upload it to GitHub:: paver gh_pages_create gh_pages_build -Paver will create a submodule of your project at ``docs/build/html``, +Paver will create a submodule of your project at ``docs/_build/html``, create a gh-pages root branch and push the branch to your project. It then build the html doc. To clean the html build folder, it update the submodule (you will lose changes not committed and pushed), @@ -145,7 +145,7 @@ You might also want to update the submodule reference (a submodule point to specific commit on a remote repository, not to the HEAD of a specific branch):: - git add docs/build/html + git add docs/_build/html git commit -m "update gh-pages submodule" Help and development README.rst @@ -33,19 +33,17 @@ The result:: for more details:: paver paverdocs - -* <project name>/src contain your package. -* <project name>/docs/source/ will contains your documentation source. conf.py +* <project name>/docs/ will contains your documentation source. conf.py is Sphinx' configuration file. Check `Sphinx' documentation <http://sphinx.pocoo.org/>`_ for more details. .. note:: The version number, the project name and author name(s) are set in - ``pavement.py`` and shared with ``docs/source/conf.py``. + ``pavement.py`` and shared with ``docs/conf.py``. However licence and copyright information are hard coded into ``LICENCE``, - ``pavement.py``, ``docs/source/conf`` and ``src/<package>/__init__.py``. + ``pavement.py``, ``docs/conf`` and ``<package>/__init__.py``. """ src/github/tools/template.py 641c6b182bc906c5febc01b71e279608e8c66cf5 Damien Lebrun dinoboff@hotmail.com http://github.com/dinoboff/github-tools/commit/a08dbec9eb0062e9bb5a3cc727d1eb1a3b407996 a08dbec9eb0062e9bb5a3cc727d1eb1a3b407996 2009-08-26T06:51:44-07:00 2009-08-26T06:51:44-07:00 Update doc with new layout e2a8a41b0840a49ae172c43816c720b2b0b1b72c Damien Lebrun dinoboff@hotmail.com