Permalink
Browse files

DOC: add developer docs based on gitwash

  • Loading branch information...
1 parent 816adf9 commit 8b0453630961b5788c83381c276c63273cdd53b7 @pv pv committed Oct 4, 2010
View
10 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
View
2 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>
View
1 doc/source/contents.rst
@@ -6,6 +6,7 @@ Numpy manual contents
user/index
reference/index
+ dev/index
release
about
bugs
View
3 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
View
8 doc/source/dev/index.rst
@@ -0,0 +1,8 @@
+#####################
+Contributing to Numpy
+#####################
+
+.. toctree::
+ :maxdepth: 1
+
+ gitwash/index

0 comments on commit 8b04536

Please sign in to comment.