Closed wvmarle closed 11 years ago
Download Sphinx-ready docs here: http://squirrel-systems.com/glacier-cmd-doc.tgz
For some reason .. program-output ::
does not work for me (the required extension is installed) but that's a minor detail. The rest works and looks good to me in html. Cool stuff! Better for someone with a dedicated test account at amazon to run those commands.
Many TODO tags in the text - this are bits that need checking/updating.
Command line options may also be incomplete, I didn't check on that: just adapted the existing README file.
Also I noticed Sphinx can make an auto-documentation from Python source code, that's something to check, I think it'd be really useful if we could get a doc page which simply has the source documentation. Very useful for people like me who jump onto an existing project to figure out what's going on.
Cool thanks. sphinx-autodoc enables you auto creation of rst from source. On Sep 27, 2012 8:18 AM, "wvmarle" notifications@github.com wrote:
Download Sphinx-ready docs here: http://squirrel-systems.com/glacier-cmd-doc.tgz
For some reason .. program-output :: does not work for me (the required extension is installed) but that's a minor detail. The rest works and looks good to me in html. Cool stuff! Better for someone with a dedicated test account at amazon to run those commands. Many TODO tags in the text - this are bits that need checking/updating. Command line options may also be incomplete, I didn't check on that: just adapted the existing README file.
Also I noticed Sphinx can make an auto-documentation from Python source code, that's something to check, I think it'd be really useful if we could get a doc page which simply has the source documentation. Very useful for people like me who jump onto an existing project to figure out what's going on.
— Reply to this email directly or view it on GitHubhttps://github.com/uskudnik/amazon-glacier-cmd-interface/issues/51#issuecomment-8926892.
Something like that indeed. But of course documentation still has to be added to the source first :-)
Well just did a pull request on glacier_lib.
At the moment I really don't understand which branch I'm working against. Git is truly driving me crazy. Not updating stuff, updating other stuff, messing up stuff - terrible.
I tried to checkout the tree from offlinehacker, and I believe I got that data and the commit is against that version.
However I can't make a pull request there, nor make a fork of the code (same name or so?)
So while I'm happy to start hacking GlacierWrapper I'd like to know for sure which version I'm working with. Otherwise it's going to be even more chaos than that Y%$#$(^%& git produces already.
I will reference what @uskudnik wrote.
Also i can help you by using git if you give me some contact informations, for example on email(jakahudoklin@gmail.com) we can talk an i will help you with your commits to glacier. I use google-talk/irc/facebook, whatever you choose ;)
I think we can close this ticket, since it's not connected with this project.
Agreed.
OK so now I've created a nice ./doc tree with lots of files that compile great with Sphinx.
$ git commit -a -m "Added Sphinx-style documentation." [wrapper 7c5dfbc] Added Sphinx-style documentation. 53 files changed, 5155 insertions(+), 0 deletions(-) create mode 100644 doc/About.rst create mode 100644 doc/Development.rst create mode 100644 doc/Installation.rst .....
Looks good. All files are listed there (here cut for readability). Next step.
$ git push -u master origin fatal: 'master' does not appear to be a git repository fatal: The remote end hung up unexpectedly wouter@acorn:~/Projects/amazon-glacier-cmd-interface$ git push -u origin master bash: warning: setlocale: LC_ALL: cannot change locale (en_GB.UTF-8) Branch master set up to track remote branch master from origin. Everything up-to-date
WTF? Nothing added to my forked repo, and now a git status tells me there are no updates! This was exactly how I added previous commits to my repo.