hipercam online documentation

[paulkerry1]

Just to flag that I've noticed that the existing online documentation that is linked from the blog and Vik's hipercam pages points to...
https://cygnus.astro.warwick.ac.uk/phsaap/hipercam/docs/html/
which is stamped "HiPERCAM pipeline 1.2.1.dev0+gedb84f5.d20220329 documentation", which is out of date given that we are currently on version 1.6.2

Should we be hosting an updated online resource?

Also to note...
https://cygnus.astro.warwick.ac.uk/phsaap/hipercam/docs/html/commands.html?highlight=ltimes#hipercam.scripts.ltimes
contains a red "Warning" box with "This routine does not yet work with ULTRACAM data." - is that now correct?
As the indentation layout of the documentation isn't consistent, it could be easy for someone to assume that warning belongs to the next section below: e.g.
c.f. https://cygnus.astro.warwick.ac.uk/phsaap/hipercam/docs/html/commands.html?highlight=ltimes#hipercam.scripts.makebias
which has a green "Note" box indented which reads well
c.f. https://cygnus.astro.warwick.ac.uk/phsaap/hipercam/docs/html/commands.html?highlight=ltimes#hipercam.scripts.nrtplot
which has a green "Note" box that is not indented

Also...
https://cygnus.astro.warwick.ac.uk/phsaap/hipercam/docs/html/organisation.html
describes folders as being in YYYY-MM-DD format instead of YYYY_MM_DD which we have been using since inception.

Paul

[vikdhillon]

Hi Pablo, thanks for pointing this out. I imagine the html is auto generated whenever Tom came up with a new version (?) and then Tom used to manually upload the html to the server at Warwick for everyone to access via the www? So I guess this is why it hasn't been updated at Warwick for so long? So yes, I think we should definitely be hosting the up-to-date user guide at Sheffield. The one currently linked to on the Sheffield HiPERCAM resources page was put there by me a while ago, and is also out of date now. I'd be happy to renew this every time a new version is released, although maybe it would be better if this is done more centrally somehow?

[StuartLittlefair]

The usual way this is done automatically is by a service like readthedocs - this is how the hcam-finders docs are hosted. We should integrate this here.

[martinjohndyer]

This was on my list to take a look at, although I guess I never made an issue. It should be straightforward to get the docs to build automatically using GitHub Actions and then host them here, I can take a look at getting that set up.

[martinjohndyer]

Right, a little bit of messing around and the docs are now being published to https://hipercam.github.io/hipercam/. Not the neatest URL, but the nice thing is that those pages should now be automatically updated and published whenever changes are pushed to the repo using the GitHub Actions system (https://github.com/HiPERCAM/hipercam/actions).

That's very much just an initial proof of concept, I haven't looked at anything else Pablo mentioned, and there are still some annoying issues with getting the automatic version detection working. But eventually that address should be where we point anyone for the package documentation going forward.

[vikdhillon]

Thanks Martin. That link seems to point to a development version at the moment? Is that correct?

…

--- Prof. Vik Dhillon, Astrophysics Research Cluster School of Mathematical & Physical Sciences University of Sheffield, Sheffield S3 7RH, UK vikdhillon.staff.shef.ac.uk <http://www.vikdhillon.staff.shef.ac.uk> ---

On Fri, 25 Jul 2025 at 15:58, Martin Dyer ***@***.***> wrote: *martinjohndyer* left a comment (HiPERCAM/hipercam#149) <#149 (comment)> Right, a little bit of messing around and the docs are now being published to https://hipercam.github.io/hipercam/. Not the neatest URL, but the nice thing is that those pages should now be automatically updated and published whenever changes are pushed to the repo using the GitHub Actions system (https://github.com/HiPERCAM/hipercam/actions). That's very much just an initial proof of concept, I haven't looked at anything else Pablo mentioned, and there are still some annoying issues with getting the automatic version detection working. But eventually that address should be where we point anyone for the package documentation going forward. — Reply to this email directly, view it on GitHub <#149 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AC46DHAWZ4CFAZPGUD7DTWT3KJAZXAVCNFSM6AAAAACCI2KSJSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTCMJYGM2TGMJSGQ> . You are receiving this because you commented.Message ID: ***@***.***>

[paulkerry1]

Thanks Martin - I've linked that new page from the blog.

[martinjohndyer]

Thanks both.

That link seems to point to a development version at the moment? Is that
correct?

That's the issue I mentioned in my last comment, the documentation is all up-to-date for the latest version but the version number at the top left isn't fetching correctly for whatever reason.

There are a few other bugs I've found, like the automatically-generated list of scripts on https://hipercam.github.io/hipercam/commands.html#command-definitions isn't being written (unlike https://vikdhillon.staff.shef.ac.uk/hipercam/pipeline/commands.html#command-definitions). I think a lot is due to the automated actions using much newer versions of the programs that write and format the documentation, so I'll have to go through and do some updating.

Thanks Martin - I've linked that new page from the blog.

Thanks Paul, although as I said the previous post this was really the first stage of getting the docs to be published automatically and there are still quite a few things that need to be checked and updated (as above!). So it's probably best people keep using https://vikdhillon.staff.shef.ac.uk/hipercam/pipeline/ for the time being, even if it's not completely up to date.

[paulkerry1]

Thanks Paul, although as I said the previous post this was really the first stage of getting the docs to be published automatically and there are still quite a few things that need to be checked and updated (as above!). So it's probably best people keep using https://vikdhillon.staff.shef.ac.uk/hipercam/pipeline/ for the time being, even if it's not completely up to date.

OK, but that link you mentioned on Vik's page isn't on the blog - it's been linked to a page of Tom's!