github/CoolProp
1
1
Fork 0
mirror of https://github.com/CoolProp/CoolProp.git synced 2026-04-01 03:00:13 -04:00
Code Issues Packages Projects Releases Wiki Activity

Preparations to move the docs to the new OSX slave.

Browse Source
This commit is contained in:
Jorrit Wronski
2014-11-26 11:50:47 +01:00
parent 8642569674
commit 57ce1bd666
2 changed files with 14 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Web/develop/documentation.rst
View File

@@ -7,6 +7,12 @@ Documentation
Build Sphinx documentation
--------------------------
0. On a Mac system, you should add the local string to your bash environment in ``/Users/username/.bash_profile``::
export LC_ALL=en_US.UTF-8
export LANG=en_US.UTF-8
1. Check out the sources in the CoolProp/Web folder::
git clone https://github.com/CoolProp/CoolProp --recursive

16
dev/buildbot/master/master.cfg
View File

@@ -241,7 +241,7 @@ def fullBuildCommand(props):
def websiteFactory(platform, gitMode='incremental', fullBuild=False):
if 'win' in platform.lower():
raise ValueError("The docs cannot be build on a Windows machine, we rely on rsync...")
# Some basic preparations
# Some basic preparations, make sure the machine has passwordless SSH access to the server
server_uri = 'coolprop@coolprop.dreamhosters.com'
server_dir = '/home/coolprop/buildbot/server-master'
server_des = "{0}:{1}".format(server_uri,server_dir)
@@ -251,20 +251,20 @@ def websiteFactory(platform, gitMode='incremental', fullBuild=False):
#
# Create the factory to add the actions to
factory = getBaseFactory(gitMode=gitMode)
# Install the latest CoolProp
# Install the latest CoolProp system-wide - Migh cause errors if not run in virtual environment
factory.addStep(ShellCommand(command=["python", "setup.py", "install"], workdir= 'build/wrappers/Python', haltOnFailure = True))
# Test the compiled CoolProp
factory.addStep(ShellCommand(command=["python", "-c", "\"import CoolProp; print(CoolProp.__gitrevision__)\""], workdir= 'build/wrappers/Python', haltOnFailure = True))
# Create plots and fluid tables
factory.addStep(ShellCommand(command=fullBuildCommand, workdir= 'build/Web/scripts', haltOnFailure = True))
# Run sphinx build
factory.addStep(ShellCommand(command=["python", "-c", "\"import CoolProp; print(CoolProp.__file___)\""], workdir= 'build/wrappers/Python', haltOnFailure = True))
# Run doxygen build
factory.addStep(ShellCommand(command=' '.join(["doxygen", "--version", "&&", "doxygen", "Doxyfile"]), workdir= 'build', haltOnFailure = True))
factory.addStep(ShellCommand(command=["doxygen", "--version", "&&", "doxygen", "Doxyfile"], workdir= 'build', haltOnFailure = True))
# Run sphinx apidoc
#factory.addStep(ShellCommand(command=["sphinx-apidoc","-T","-f","-o","apidoc","../CoolProp"],workdir= 'build/Web', haltOnFailure = True))
# Run sphinx website builder
factory.addStep(ShellCommand(command=["make", "html"], workdir= 'build/Web', haltOnFailure = True))
# Upload the generated files
factory.addStep(ShellCommand(command = 'rsync -a --stats {0}/ {1}'.format(local_build_dir,server_target_dir), haltOnFailure = True))
factory.addStep(ShellCommand(command=['rsync', '-a', '--stats', '{0}/ {1}'.format(local_build_dir,server_target_dir)], haltOnFailure = True))
return factory
@@ -728,8 +728,8 @@ c['builders'].append(
c['builders'].append(
BuilderConfig(
name="Sphinx docs",
slavenames=["linux32-slave"],
factory = websiteFactory(platform = 'linux')
slavenames=["OSX-IPU-slave"],
factory = websiteFactory(platform = 'osx')
)
)