Skip to content
Snippets Groups Projects
Commit fdd4674e authored by Christoph Groth's avatar Christoph Groth
Browse files

RELEASE.rst: correct and streamline doc building and uploading

parent 4b7fd23b
No related branches found
No related tags found
No related merge requests found
...@@ -114,21 +114,23 @@ Building the documentation requires 'sphinx' and a Latex installation. ...@@ -114,21 +114,23 @@ Building the documentation requires 'sphinx' and a Latex installation.
First build the HTML and PDF documentation:: First build the HTML and PDF documentation::
./setup.py build ./setup.py build
cd doc make -C doc realclean
make realclean make -C doc html latex
make html latex SPHINXOPTS='-A website_deploy=True -n -W' make -C doc/build/latex all-pdf
cd doc/build/latex
make all-pdf
Then create a zipped version of the HTML documentation and name the PDF Then create a zipped version of the HTML documentation and name the PDF
consistently, storing them, for example, in the "dist" directory along with the consistently, storing them, for example, in the "dist" directory along with the
source tarballs:: source tarballs::
ln -s `pwd`/doc/build/html /tmp/kwant-doc-<version> version=$(git describe | sed 's/^v//') # Assumes that we are on a tag.
(cd /tmp/; zip -r kwant-doc-<version>.zip kwant-doc-<version>) ln -s `pwd`/doc/build/html /tmp/kwant-doc-$version
mv /tmp/kwant-doc-<version>.zip dist (cd /tmp/; zip -r kwant-doc-$version.zip kwant-doc-$version)
mv /tmp/kwant-doc-$version.zip dist
mv doc/build/latex/kwant.pdf dist/kwant-doc-$version.pdf
mv doc/build/latex/kwant.pdf dist/kwant-doc-<version>.pdf Finally, rebuild the documentation for the website (including the web analysis javascript code)::
make -C doc html SPHINXOPTS='-A website_deploy=True -n -W'
Clone the repository of the Kwant Debian package Clone the repository of the Kwant Debian package
...@@ -514,23 +516,20 @@ Ask Christoph Groth if you need to be granted access. ...@@ -514,23 +516,20 @@ Ask Christoph Groth if you need to be granted access.
Upload the zipped HTML and PDF documentation:: Upload the zipped HTML and PDF documentation::
scp dist/kwant-doc-<version>.zip kwant-project.org:webapps/downloads/doc scp dist/kwant-doc-<version>.{zip,pdf} kwant-project.org:webapps/downloads/doc
scp dist/kwant-doc-<version>.pdf kwant-project.org:webapps/downloads/doc
Point the symbolic links ``latest.zip`` and ``latest.pdf`` to these new files::
ssh kwant-project.org "cd webapps/downloads/doc; ln -s kwant-doc-<version>.zip latest.zip"
ssh kwant-project.org "cd webapps/downloads/doc; ln -s kwant-doc-<version>.pdf latest.pdf"
Then upload the HTML documentation for the main website:: Upload the HTML documentation for the website::
rsync -rlv --delete doc/build/html/* kwant-project.org:webapps/kwant/doc/<short-version> rsync -rlv --delete doc/build/html/* kwant-project.org:webapps/kwant/doc/<short-version>
where in the above ``<short-version>`` is just the major and minor version numbers. where in the above ``<short-version>`` is just the major and minor version numbers.
Finally point the symbolic link ``<major-version>`` to ``<short-version>``:: Finally, create symbolic links for the website::
ssh kwant-project.org "cd webapps/kwant/doc; ln -s <major> <short-version>" ssh kwant-project.org
for e in zip pdf; do ln -sf kwant-doc-<version>.$e webapps/downloads/doc/latest.$e; done
ln -nsf <short-version> webapps/kwant/doc/<major>
exit
Announce the release Announce the release
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment