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

fix xonsh links #14

Merged
merged 2 commits into from Mar 2, 2018
Merged

fix xonsh links #14

merged 2 commits into from Mar 2, 2018

Conversation

scopatz
Copy link
Member

@scopatz scopatz commented Feb 28, 2018

Should fix #13 CC @gonuke @FlanFlanagan

Copy link
Member

@gonuke gonuke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still looks like there is one lingering reference to xonsh

docs/conf.py Outdated
@@ -211,7 +211,7 @@
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'xonsh.tex', u'xonsh documentation',
('index', 'xonsh.tex', u'rickshaw documentation',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the 2nd entry still be xonsh.tex?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops! fixed!

@gonuke
Copy link
Member

gonuke commented Mar 2, 2018

LGTM - thanks @scopatz

@gonuke gonuke merged commit 108a546 into cyclus:master Mar 2, 2018
@gonuke
Copy link
Member

gonuke commented Mar 2, 2018

Does this automatically get deployed? Or do I need to (figure out how to) do that?

@scopatz
Copy link
Member Author

scopatz commented Mar 3, 2018

It seems that doctr is set up on this repo, so it should have already been deployed.

@scopatz scopatz deleted the link branch March 3, 2018 16:23
@gonuke
Copy link
Member

gonuke commented Mar 3, 2018

cool - this is my first look at doctr... I can't help but feel like new docs will be pushed by doctr for every PR... it that correct? intended?

@scopatz
Copy link
Member Author

scopatz commented Mar 3, 2018

Yes, I think that is what is happening. I think the idea is that the docs are built for every PR (as a test) and then when the PR is merged, the docs are built again and actually deployed (pushed to the github pages repo).

@gonuke
Copy link
Member

gonuke commented Mar 3, 2018

But it appears that the docs are deployed each time a PR is tested... or is doctr wise enough to avoid that?

@scopatz
Copy link
Member Author

scopatz commented Mar 3, 2018

I think it depends on how it is setup, and it may not be set up correctly here. @asmeurer @gforsyth and @CJ-Wright might have a better answer to that question.

@CJ-Wright
Copy link

I think doctr knows if it is building on the master branch and doesn't push unless it is on the master branch, unless you have some special settings.
You could just test this by putting up a trial PR and see if it shows up on the webpage.

@asmeurer
Copy link

asmeurer commented Mar 3, 2018

doctr only pushes from master unless --no-require-master is used (it isn't being used in this repo), and even then, it is impossible to push from a pull request from a fork.

@asmeurer
Copy link

asmeurer commented Mar 3, 2018

And yes, in a PR, doctr runs all the steps of the deploy sans the push in every build to ensure that they would work. But the push is not done (see https://travis-ci.org/cyclus/rickshaw/builds/347951348#L1373). It seems we need to color the doctr output better.

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

Successfully merging this pull request may close these issues.

bad link on front page of docs
4 participants