Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Also integrate the sphinx docs into the binaries/release/unstable folder output #378

Closed
ibell opened this issue Jan 1, 2015 · 9 comments
Assignees
Milestone

Comments

@ibell
Copy link
Contributor

ibell commented Jan 1, 2015

I am not sure how best to handle this, but we should make sure that when we do a release, the docs are up to date with the release branch. Currently they always upload to public_html/binaries

@ibell ibell added this to the v5.0.6 milestone Jan 1, 2015
@jowr
Copy link
Member

jowr commented Jan 2, 2015

I'll have a look - docs are always uploaded to Sphinx, only the release script pushes a zip files to binaries...

@ibell
Copy link
Contributor Author

ibell commented Jan 3, 2015

Yes, always uploading to public_html/sphinx is the problem, but I'm not
sure how to fix this because we need to use something that is renderable.

On Fri, Jan 2, 2015 at 5:51 AM, Jorrit Wronski notifications@github.com
wrote:

I'll have a look - docs are always uploaded to Sphinx, only the release
script pushes a zip files to binaries...


Reply to this email directly or view it on GitHub
#378 (comment).

ibell added a commit that referenced this issue Jan 8, 2015
…unstable folder output; see #378

Signed-off-by: Ian Bell <ian.h.bell@gmail.com>
@ibell ibell closed this as completed Jan 12, 2015
@jowr
Copy link
Member

jowr commented Jan 13, 2015

This is not done. The commit f635528 messed up the release script.

This line https://github.com/CoolProp/CoolProp/blob/master/dev/scripts/release.bsh#L106 refers to folderm that has been replaced by 'sphinx' and this one https://github.com/CoolProp/CoolProp/blob/master/dev/scripts/release.bsh#L118 expands to $BASEDIR/$BINFOLDER/sphinx/sphinx is that intended? Do we really want the sphinx files on sourceforge - http://sourceforge.net/projects/coolprop/files/CoolProp/5.0.6/sphinx ?

If you could explain the desired behaviour, I might be able to help 😉

@jowr jowr reopened this Jan 13, 2015
@ibell
Copy link
Contributor Author

ibell commented Jan 13, 2015

Argh. Sorrry about that. The idea is that we also want the docs to be
built in the same way as the binaries, getting put into binaries/sphinx for
a build from master branch, or release/sphinx when built from release
branch. That way we can be 100% sure that the docs are also tagged to the
same revision as the binaries. Furthermore, I am now automatically forcing
a full rebuild of all binary builders as well as the docs if the branch is
release, so that should avoid old files ending up in sphinx docs.

$BASEDIR/$BINFOLDER/sphinx/sphinx should be $BASEDIR/$BINFOLDER/sphinx I
think

And no, I don't think we want the sphinx files on SF :)

Ian

On Tue, Jan 13, 2015 at 7:38 AM, Jorrit Wronski notifications@github.com
wrote:

This is not done. The commit f635528
f635528
messed up the release script.

This line
https://github.com/CoolProp/CoolProp/blob/master/dev/scripts/release.bsh#L106
refers to folderm that has been replaced by 'sphinx' and this one
https://github.com/CoolProp/CoolProp/blob/master/dev/scripts/release.bsh#L118
expands to $BASEDIR/$BINFOLDER/sphinx/sphinx is that intended? Do we
really want the sphinx files on sourceforge -
http://sourceforge.net/projects/coolprop/files/CoolProp/5.0.6/sphinx ?

If you could explain the desired behaviour, I might be able to help [image:
😉]


Reply to this email directly or view it on GitHub
#378 (comment).

@jowr
Copy link
Member

jowr commented Jan 13, 2015

OK, I'll have a look. Thanks.

jowr pushed a commit that referenced this issue Jan 13, 2015
@jowr
Copy link
Member

jowr commented Jan 13, 2015

I just committed some changes to the script. I could not test the upload of the docs without making a release, but the rest should work. Let us keep this issue around until the new script is fully tested.

@ibell
Copy link
Contributor Author

ibell commented Jan 14, 2015

Yes, sounds good. What was the problem with the docs when I released
v5.0.6? It looks ok to me from a cursory glance.

Ian

On Tue, Jan 13, 2015 at 9:58 AM, Jorrit Wronski notifications@github.com
wrote:

I just committed some changes to the script. I could not test the upload
of the docs without making a release, but the rest should work. Let us keep
this issue around until the new script is fully tested.


Reply to this email directly or view it on GitHub
#378 (comment).

@jowr
Copy link
Member

jowr commented Jan 14, 2015

The sphynx folder was on SourceForge and the zip file was not generated correctly.

@ibell
Copy link
Contributor Author

ibell commented Feb 12, 2015

Umm @jowr, are we safe to close this one after the 5.0.7 release? It looks good to me I think, there are the docs in a zip file, and no sphinx directory

@ibell ibell closed this as completed Feb 13, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants