diff options
| author | Pauli Virtanen <pav@iki.fi> | 2010-10-04 21:22:57 +0200 |
|---|---|---|
| committer | Pauli Virtanen <pav@iki.fi> | 2010-10-04 21:55:43 +0200 |
| commit | 8b0453630961b5788c83381c276c63273cdd53b7 (patch) | |
| tree | feb56516b83b52677ab7e9b790a1905c1f01d9d2 /doc | |
| parent | 816adf97406ce3a6d2aa3059e6b84de6791b0ee3 (diff) | |
| download | numpy-8b0453630961b5788c83381c276c63273cdd53b7.tar.gz | |
DOC: add developer docs based on gitwash
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile | 10 | ||||
| -rw-r--r-- | doc/source/_templates/indexcontent.html | 2 | ||||
| -rw-r--r-- | doc/source/contents.rst | 1 | ||||
| -rw-r--r-- | doc/source/dev/gitwash_links.txt | 3 | ||||
| -rw-r--r-- | doc/source/dev/index.rst | 8 |
5 files changed, 23 insertions, 1 deletions
diff --git a/doc/Makefile b/doc/Makefile index 30caa1f3b..03b327079 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -17,7 +17,7 @@ PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source .PHONY: help clean html web pickle htmlhelp latex changes linkcheck \ - dist dist-build + dist dist-build gitwash-update #------------------------------------------------------------------------------ @@ -31,10 +31,18 @@ help: @echo " linkcheck to check all external links for integrity" @echo " dist PYVER=... to make a distribution-ready tree" @echo " upload USER=... to upload results to docs.scipy.org" + @echo " gitwash-update GITWASH=path/to/gitwash update gitwash developer docs" clean: -rm -rf build/* source/reference/generated +gitwash-update: + rm -rf source/dev/gitwash + install -d source/dev/gitwash + python $(GITWASH)/gitwash_dumper.py source/dev NumPy \ + --repo-name=numpy \ + --github-user=numpy + cat source/dev/gitwash_links.txt >> source/dev/gitwash/git_links.inc #------------------------------------------------------------------------------ # Automated generation of all documents diff --git a/doc/source/_templates/indexcontent.html b/doc/source/_templates/indexcontent.html index 49d955d8c..b497c93dd 100644 --- a/doc/source/_templates/indexcontent.html +++ b/doc/source/_templates/indexcontent.html @@ -7,6 +7,8 @@ <span class="linkdescr">start here</span></p> <p class="biglink"><a class="biglink" href="{{ pathto("reference/index") }}">Numpy Reference</a><br/> <span class="linkdescr">reference documentation</span></p> + <p class="biglink"><a class="biglink" href="{{ pathto("dev/index") }}">Numpy Developer Guide</a><br/> + <span class="linkdescr">contributing to NumPy</span></p> </td></tr> </table> diff --git a/doc/source/contents.rst b/doc/source/contents.rst index 31ade2306..04ee229b2 100644 --- a/doc/source/contents.rst +++ b/doc/source/contents.rst @@ -6,6 +6,7 @@ Numpy manual contents user/index reference/index + dev/index release about bugs diff --git a/doc/source/dev/gitwash_links.txt b/doc/source/dev/gitwash_links.txt new file mode 100644 index 000000000..c598ba4aa --- /dev/null +++ b/doc/source/dev/gitwash_links.txt @@ -0,0 +1,3 @@ +.. _NumPy: http://numpy.scipy.org +.. _`NumPy github`: http://github.com/numpy/numpy +.. _`NumPy mailing list`: http://scipy.org/Mailing_Lists diff --git a/doc/source/dev/index.rst b/doc/source/dev/index.rst new file mode 100644 index 000000000..727c2f4f2 --- /dev/null +++ b/doc/source/dev/index.rst @@ -0,0 +1,8 @@ +##################### +Contributing to Numpy +##################### + +.. toctree:: + :maxdepth: 1 + + gitwash/index |