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

Documentation disaster is ahead #33

Open
techtonik opened this issue Feb 11, 2016 · 9 comments
Open

Documentation disaster is ahead #33

techtonik opened this issue Feb 11, 2016 · 9 comments

Comments

@techtonik
Copy link
Contributor

I see that my commit is not online 95c41f6

And the day somebody decides to follow the README.md to push it will probably kill other changes that are alive.

The solution is to merge changes from the source branch, kill it and setup Sphinx to regenerate HTML in master from _sources/ without overwriting them.

@matthew-brett
Copy link
Member

I guess the solution is to have a travis process that pushes to github automatically, but for now, I've just pushed the current master. Feel free to give me a push if it gets out of date again.

@techtonik
Copy link
Contributor Author

Thanks. I will try to create an exemplary Sphinx project that contains both readable HTML site and sources in one branch.

@matthew-brett
Copy link
Member

Will that solve anything though? Unless you're suggesting that the PRs have the source and the built HTML together?

@njsmith
Copy link
Contributor

njsmith commented Feb 11, 2016

Different branches (or even repos), with travis responsible for syncing
between them, certainly seems like the easiest approach to me.

On Thu, Feb 11, 2016 at 1:01 AM, Matthew Brett [email protected]
wrote:

Will that solve anything though? Unless you're suggesting that the PRs
have the source and the built HTML together?


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

Nathaniel J. Smith -- https://vorpus.org http://vorpus.org

@techtonik
Copy link
Contributor Author

Unless you're suggesting that the PRs have the source and the built HTML together?

Yes. Edit the source, preview it locally and commit both.

Different branches (or even repos), with travis responsible for syncing between them, certainly seems like the easiest approach to me.

Yes, but I have no idea how that is set up.

@njsmith
Copy link
Contributor

njsmith commented Feb 11, 2016

There's probably some less terse explanation of how this works somewhere,
but:
https://github.com/matplotlib/matplotlib/blob/master/.travis.yml#L147-L169

(or the matplotlib folks are probably happy to explain more, they're
friendly)

On Thu, Feb 11, 2016 at 1:20 AM, anatoly techtonik <[email protected]

wrote:

Unless you're suggesting that the PRs have the source and the built HTML
together?

Yes. Edit the source, preview it locally and commit both.

Different branches (or even repos), with travis responsible for syncing
between them, certainly seems like the easiest approach to me.

Yes, but I have no idea how that is set up.


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

Nathaniel J. Smith -- https://vorpus.org http://vorpus.org

@techtonik
Copy link
Contributor Author

That's a good example. I don't think explanation is necessary - just some time to read where to configure Travis deploy key and why to encrypt it. If the key appears to be present on Travis site only.

@njsmith
Copy link
Contributor

njsmith commented Feb 11, 2016

The key that has write access to github is stored in the .travis.yml file
at the top, where anyone can see it, so it has to itself be encrypted with
a key that only Travis knows.
On Feb 11, 2016 1:46 AM, "anatoly techtonik" [email protected]
wrote:

That's a good example. I don't think explanation is necessary - just some
time to read where to configure Travis deploy key and why to encrypt it. If
the key appears to be present on Travis site only.


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

techtonik added a commit to techtonik/mingwpy.github.io that referenced this issue Feb 11, 2016
Check to see if local .travis.yml works.
See mingwpy#33 (comment)
@techtonik
Copy link
Contributor Author

Now somebody needs to enable Travis for this repository

techtonik added a commit to techtonik/mingwpy.github.io that referenced this issue Feb 12, 2016
Check to see if local .travis.yml works.
See mingwpy#33 (comment)
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

3 participants