doc updates
Robert Schuppenies
update the docs? They respond to our current API and when we change
the API we will need to adapt the docs as well. Maybe we should
start keeping (at least) the library docs under a version-aware
path, such as Pympler/0.1/library. Or we keep an entire copy of old
docs under such a path. But this is just an idea from the top of my
head. What do you suggest?
How do you think about some version number for the docs (maybe based
on the repository revision number)? I think I will be quickly mixed
up as soon as a number of zips have been created. Or will we update
the docs only when we have new releases?
BTW: Ludwig, could you document the steps you took for generating
and uploading the docs? I think developes-notes.txt are a good place
to do so.
Ludwig Hähne
> A question I havn't found a good answer to is, when should we
> update the docs? They respond to our current API and when we change
> the API we will need to adapt the docs as well. Maybe we should
> start keeping (at least) the library docs under a version-aware
> path, such as Pympler/0.1/library. Or we keep an entire copy of old
> docs under such a path. But this is just an idea from the top of my
> head. What do you suggest?
Good idea. But let's not start this until the next Pympler release is
ready (see below).
> How do you think about some version number for the docs (maybe based
> on the repository revision number)? I think I will be quickly mixed
> up as soon as a number of zips have been created. Or will we update
> the docs only when we have new releases?
The online docs? We ship the up-to-date docs in the distribution and
bleeding edge docs can be generated using sphinx. I think the online
docs should only be updated along with releasing new versions.
> BTW: Ludwig, could you document the steps you took for generating
> and uploading the docs? I think developes-notes.txt are a good place
> to do so.
I was going to, but there is still a problem. You may have seen that I
added a zipping function to run.py which should create the doc archive
ready for Pypi upload. However, the zip is rejected for some reason with
an odd error. The produced archive seems to be intact, but somewhere
there must be a problem that makes Pypi fail on it. When the archive is
created with system tools, it works fine.
Unfortunately, debugging this problem requires to test it, which blows
up the online do documentation temporarily if the zip is rejected.
It would be nice if either of you could take a look at the zipping
function. It might be a coding error or related to my Python
version/platform (2.5.2 @ 32bit Linux).
Ludwig
Robert Schuppenies
>> and uploading the docs? I think developes-notes.txt are a good place
>> to do so.
>
> I was going to, but there is still a problem. You may have seen that I
> added a zipping function to run.py which should create the doc archive
> ready for Pypi upload. However, the zip is rejected for some reason with
> an odd error. The produced archive seems to be intact, but somewhere
> there must be a problem that makes Pypi fail on it. When the archive is
> created with system tools, it works fine.
>
> Unfortunately, debugging this problem requires to test it, which blows
> up the online do documentation temporarily if the zip is rejected.
>
> It would be nice if either of you could take a look at the zipping
> function. It might be a coding error or related to my Python
> version/platform (2.5.2 @ 32bit Linux).
I'll have a look. In this process, I will take the risk of shutting
the online-docs down for a matter of seconds/minutes.