search

amahabal / PySeqsee

Python framework for writing programs to solve complex problems not amenable to brute force. The architecture is a descendant of Douglas Hofstadter and Melanie Mitchell's Copycat architecture.
http://amahabal.github.com/PySeqsee/
GNU General Public License v3.0
32 stars 10 forks source link

Make updating docs easier #25

Closed superMDguy closed 7 years ago

superMDguy commented 7 years ago

@amahabal could you modify the github pages settings so the root directory for the website is docs/_build/html? That way the docs would auto update by just doing make html, without switching over to the gh-pages branch and modifying it.

amahabal commented 7 years ago

I agree that the current setting is cumbersome.

Do you know what I would need to do? I see the following options on the settings page for the source of github pages

(A) the gh-pages branch (which is what I have currently). (B) master branch (C) master branch /docs folder.

Does (C) correspond to what you are suggesting?

Thanks, Abhijit

On Mon, Jan 9, 2017 at 2:46 PM Matthew D. notifications@github.com wrote:

Assigned #25 https://github.com/amahabal/PySeqsee/issues/25 to @amahabal https://github.com/amahabal.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/amahabal/PySeqsee/issues/25#event-916707188, or mute the thread https://github.com/notifications/unsubscribe-auth/AADFvH6xu9BAiEYNeSaIMzUZyPj1C1L5ks5rQriwgaJpZM4Le0nz .

superMDguy commented 7 years ago

C would be the best option, though it's not ideal. We'd have to rename the current docs folder to something else, and use the new docs folder exclusively for the compiled html

amahabal commented 7 years ago

Alright, I will make that transition tonight (unless you beat me to it!)

On Mon, Jan 9, 2017 at 3:00 PM Matthew D. notifications@github.com wrote:

C would be the best option, though it's not ideal. We'd have to rename the current docs folder to something else, and use the new docs folder exclusively for the compiled html

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/amahabal/PySeqsee/issues/25#issuecomment-271435579, or mute the thread https://github.com/notifications/unsubscribe-auth/AADFvAMJ6SumhR2joU0gLB3OZZqr0pilks5rQrwhgaJpZM4Le0nz .

superMDguy commented 7 years ago

I actually just found this gist, which gives a simpler way to transfer a folder to the gh-pages branch. Now, to update the docs we can just do

$ make html
$ git subtree push --prefix docs/_build/html origin gh-pages

That's simpler than having to checkout the gh-pages branch, which is what I was doing.

amahabal commented 7 years ago

I use the following workflow that I am not too unhappy about. It does not involve switching branches. See if that works for you.

I have two repositories checked out for Pyseqsee. One tracks the master branch, the other the gh-pages branch. When I am ready to push documentation, I do "make html" in the master branch, go to the other repository, and copy files from there, and push.

Ugly, but workable with a script. This avoids making two copies of the documentation (I think currently the _build directory on master is gitignored). Would this hack work for you?

superMDguy commented 7 years ago

Yeah, I don't think there's any simpler solution by changing the github pages settings.