Browse code

correct RELEASE.rst

Christoph Groth authored on 27/02/2019 17:27:02
Showing 1 changed files
... ...
@@ -120,10 +120,15 @@ First build the HTML and PDF documentation::
120 120
     cd doc/build/latex
121 121
     make all-pdf
122 122
 
123
-Then create a zipped version of the HTML documentation and name the PDF consistently::
123
+Then create a zipped version of the HTML documentation and name the PDF
124
+consistently, storing them, for example, in the "dist" directory along with the
125
+source tarballs::
124 126
 
125
-    zip -r docs/build/kwant-doc-<version>.zip docs/build/docs/build/html
126
-    mv docs/build/latex/kwant.pdf docs/build/kwant-doc-<version>.pdf
127
+    ln -s `pwd`/doc/build/html /tmp/kwant-doc-<version>
128
+    (cd /tmp/; zip -r kwant-doc-<version>.zip kwant-doc-<version>)
129
+    mv /tmp/kwant-doc-<version>.zip dist
130
+
131
+    mv doc/build/latex/kwant.pdf dist/kwant-doc-<version>.pdf
127 132
 
128 133
 
129 134
 Clone the repository of the Kwant Debian package
... ...
@@ -181,7 +186,7 @@ pristine tarball.  The tool `gbp pq` manages these patches as a git branch
181 186
 that branch based on the patches in ``debian/patches``::
182 187
 
183 188
     gbp pq --force import
184
-    gbp checkout master
189
+    git checkout master
185 190
 
186 191
 Now it is time to import the new source code.  There are two options.  If, as
187 192
 recommended above, the tarball of the new version has not been made public yet,
... ...
@@ -509,8 +514,8 @@ Ask Christoph Groth if you need to be granted access.
509 514
 
510 515
 Upload the zipped HTML and PDF documentation::
511 516
 
512
-    scp doc/build/kwant-doc-<version>.zip kwant-project.org:webapps/downloads/doc
513
-    scp doc/build/kwant-doc-<version>.pdf kwant-project.org:webapps/downloads/doc
517
+    scp dist/kwant-doc-<version>.zip kwant-project.org:webapps/downloads/doc
518
+    scp dist/kwant-doc-<version>.pdf kwant-project.org:webapps/downloads/doc
514 519
 
515 520
 Point the symbolic links ``latest.zip`` and ``latest.pdf`` to these new files::
516 521
 
... ...
@@ -521,7 +526,7 @@ Then upload the HTML documentation for the main website::
521 526
 
522 527
     rsync -rlv --delete doc/build/html/* kwant-project.org:webapps/kwant/doc/<short-version>
523 528
 
524
-where in the above ``<short-version`` is just the major and minor version numbers.
529
+where in the above ``<short-version>`` is just the major and minor version numbers.
525 530
 
526 531
 Finally point the symbolic link ``<major-version>`` to ``<short-version>``::
527 532