More rewriting of the doc generators

This commit is contained in:
Jorrit Wronski
2014-10-08 14:42:24 +02:00
parent f742002aa9
commit d991788141
3 changed files with 28 additions and 25 deletions

View File

@@ -70,16 +70,16 @@ your computer. For Debian/Ubuntu, we recommend as script like::
case "$1" in
start)
echo "Starting script buildbotslave "
sudo -u username buildslave start "/home/username/slave/"
sudo -u username buildslave start /home/username/slave/
;;
stop)
echo "Stopping script buildbotslave"
sudo -u username buildslave stop "/home/username/slave/"
sudo -u username buildslave stop /home/username/slave/
;;
restart)
echo "Restarting script buildbotslave"
sudo -u username buildslave stop "/home/username/slave/"
sudo -u username buildslave start "/home/username/slave/"
sudo -u username buildslave stop /home/username/slave/
sudo -u username buildslave start /home/username/slave/
;;
*)
echo "Usage: /etc/init.d/buildbotslave {start|stop|restart}"
@@ -118,15 +118,19 @@ To change the MIME types on the server so that unknown file types will map prope
and then do a ``buildbot restart master``
Nightly Documentation Builds
============================
Documentation Builds
====================
Some parts of the documentation are quite involved. That is why we decided not
to rebuild the whole documentation after every commit. There is a special buildbot
slave that runs once a day and performs the most expensive jobs. This covers the
generation of validation figures for all fluids and the fitting reports for the
incompressible fluids.
to rebuild the whole documentation after every commit. There is a special python
script that runs once every 36 hours and performs the most expensive jobs during
documentation rebuild. This covers the generation of validation figures for all
fluids and the fitting reports for the incompressible fluids.
If you have some tasks that take a long time, make sure to add them to that
special machine. This helps us to keep the continuous integration servers running
with an acceptable latency with regard to the commit to the git repository.
special script int ``Web/scripts/__init__.py``. This helps us to keep the continuous
integration servers running with an acceptable latency with regard to the commits
to the git repository. However, if you are unlucky and your commit is the first one
after 36 hours since the figures have been generated, you will experience a long
delay between your commit and the appearance of the freshly generated documentation
on the website. You can follow the progress in the logfiles on the buildbot master.

View File

@@ -18,9 +18,9 @@ Build Sphinx documentation
3. Then install prerequisites into this virtualenv::
pip install --upgrade Cython
pip install numpy scipy matplotlib
pip install cython numpy scipy matplotlib python-dateutil pytz pandas
pip install sphinx ipython sphinxcontrib-bibtex sphinxcontrib-doxylink sphinxcontrib-napoleon cloud-sptheme
pip install --upgrade cython sphinx
4. To build the documentation, go into the CoolProp/Web folder and run::
@@ -29,10 +29,6 @@ Build Sphinx documentation
5. Move the generated docs in ``_build`` to wherever you want
6. In case you try to set up a new buildbot (from http://docs.buildbot.net/current/tutorial/firstrun.html)::
pip install sqlalchemy==0.7.10 buildbot-slave
buildslave create-slave your-slave coolprop.dreamhosters.com:port your-slave pass
Build Doxygen documentation
---------------------------
@@ -53,15 +49,17 @@ Creating a Linux documentation slave
1. Make sure you have what you need. For Linux::
sudo aptitude install build-essential gfortran python-matplotlib python-pip python-dev cmake ipython git
sudo aptitude install libblas-dev liblapack-dev ngrep doxygen
sudo pip install --upgrade Cython
sudo pip install numpy scipy matplotlib
sudo pip install --upgrade sphinx ipython sphinxcontrib-bibtex sphinxcontrib-doxylink sphinxcontrib-napoleon cloud-sptheme
sudo aptitude install build-essential git gfortran cmake doxygen
sudo aptitude install python-dev ipython python-pip
sudo aptitude install python-numpy python-matplotlib python-scipy python-pandas
sudo aptitude build-deb cython
sudo pip install --upgrade cython
2. Create a new buildbot slave (from http://docs.buildbot.net/current/tutorial/firstrun.html)::
sudo pip install sqlalchemy==0.7.10 buildbot-slave
virtualenv linux-slave-sandbox
source linux-slave-sandbox/bin/activate
pip install sqlalchemy==0.7.10 buildbot-slave
buildslave create-slave your-slave coolprop.dreamhosters.com:port your-slave password
buildslave start your-slave

View File

@@ -27,7 +27,7 @@ script_dir = os.path.abspath(os.path.join(web_dir,'scripts'))
touch_file = os.path.abspath(os.path.join(script_dir,'last_run'))
#
cur_time = time.time()
lim_days = 7
lim_days = 1.5
lim_time = cur_time - 60*60*24*lim_days # seconds
fil_time = get_ftime(touch_file)
#
@@ -48,6 +48,7 @@ if full_rebuild:
script_files = glob.glob(os.path.join(script_dir,'*.sh'))
for script in script_files:
print "Executing {0}".format(script)
subprocess.call('chmod +x {0}'.format(os.path.basename(script)), cwd=script_dir, shell=True)
subprocess.call('./{0}'.format(os.path.basename(script)), cwd=script_dir, shell=True)
else:
print "Skipping the computationally expensive scripts for generating the static files."