Skip to content
This repository
Browse code

DOC: add developer docs based on gitwash

  • Loading branch information...
commit 8b0453630961b5788c83381c276c63273cdd53b7 1 parent 816adf9
Pauli Virtanen authored October 04, 2010
10  doc/Makefile
@@ -17,7 +17,7 @@ PAPEROPT_letter = -D latex_paper_size=letter
17 17
 ALLSPHINXOPTS   = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
18 18
 
19 19
 .PHONY: help clean html web pickle htmlhelp latex changes linkcheck \
20  
-        dist dist-build
  20
+        dist dist-build gitwash-update
21 21
 
22 22
 #------------------------------------------------------------------------------
23 23
 
@@ -31,10 +31,18 @@ help:
31 31
 	@echo "  linkcheck to check all external links for integrity"
32 32
 	@echo "  dist PYVER=... to make a distribution-ready tree"
33 33
 	@echo "  upload USER=...  to upload results to docs.scipy.org"
  34
+	@echo "  gitwash-update GITWASH=path/to/gitwash  update gitwash developer docs"
34 35
 
35 36
 clean:
36 37
 	-rm -rf build/* source/reference/generated
37 38
 
  39
+gitwash-update:
  40
+	rm -rf source/dev/gitwash
  41
+	install -d source/dev/gitwash
  42
+	python $(GITWASH)/gitwash_dumper.py source/dev NumPy \
  43
+	    --repo-name=numpy \
  44
+	    --github-user=numpy
  45
+	cat source/dev/gitwash_links.txt >> source/dev/gitwash/git_links.inc
38 46
 
39 47
 #------------------------------------------------------------------------------
40 48
 # Automated generation of all documents
2  doc/source/_templates/indexcontent.html
@@ -7,6 +7,8 @@
7 7
          <span class="linkdescr">start here</span></p>
8 8
       <p class="biglink"><a class="biglink" href="{{ pathto("reference/index") }}">Numpy Reference</a><br/>
9 9
          <span class="linkdescr">reference documentation</span></p>
  10
+      <p class="biglink"><a class="biglink" href="{{ pathto("dev/index") }}">Numpy Developer Guide</a><br/>
  11
+         <span class="linkdescr">contributing to NumPy</span></p>
10 12
     </td></tr>
11 13
   </table>
12 14
 
1  doc/source/contents.rst
Source Rendered
@@ -6,6 +6,7 @@ Numpy manual contents
6 6
 
7 7
    user/index
8 8
    reference/index
  9
+   dev/index
9 10
    release
10 11
    about
11 12
    bugs
3  doc/source/dev/gitwash_links.txt
... ...
@@ -0,0 +1,3 @@
8  doc/source/dev/index.rst
Source Rendered
... ...
@@ -0,0 +1,8 @@
  1
+#####################
  2
+Contributing to Numpy
  3
+#####################
  4
+
  5
+.. toctree::
  6
+   :maxdepth: 1
  7
+
  8
+   gitwash/index

0 notes on commit 8b04536

Please sign in to comment.
Something went wrong with that request. Please try again.