search

nexusformat / definitions

Definitions of the NeXus Standard File Structure and Contents
https://manual.nexusformat.org/
Other
26 stars 56 forks source link

[releng] Publish manual for v2022.06 release #1167

Closed PeterC-DLS closed 2 years ago

PeterC-DLS commented 2 years ago

Release tagged and created

PeterC-DLS commented 2 years ago

Do you mean this release 2022.06?

woutdenolf commented 2 years ago

The title says

[releng] Publish manual for (previous) v2020.10 release

but it should probably say

[releng] Publish manual for the v2022.06 release

Unless you really wanted to add the PDF of v2020.10, in which case the pdf fle is the wrong one.

PeterC-DLS commented 2 years ago

Yep, @prjemian confused? I've changed PR title back.

prjemian commented 2 years ago

The proposed PDF was for v2020.10. Per release procedure, step 10:

  1. build a PDF version of the (new version of the) manual

    • follow the naming pattern now in use (year.month, the old style was major.minor)
    • nexus- + release name + yyyy-mm-dd + GitHub commit code + .pdf
    • example new way: nexus-v2018.4-2018-04-30-abc1234.pdf

Looks good but content was not for the new version.

PeterC-DLS commented 2 years ago

Cache/CDN failure? I see nexus-manual-title and nexus-manual-contrib at https://github.com/nexusformat/definitions/blob/add-2022-06-pdf/legacy_docs/nexus-v2022.06-2022-07-05-1572327.pdf

woutdenolf commented 2 years ago

I can confirm that the committed PDF is v2022.06 This corresponds to the name of the file and the title of the PR.

Note that v2020.10 was already added in the past: https://github.com/nexusformat/definitions/commit/22b581d946ad0dc645518d85c3cb3bc6fd773d38

woutdenolf commented 2 years ago

All this because of a wrong PR title. Words matter ;-)

prjemian commented 2 years ago

I had changed the name of the PR out of some confusion of mine. These names are clear to me now. But the additional problem I reported is one of nesting and organization in the PDF that we probably cannot see in the HTML.

Clipboard01

Sections titled Base Class Definitions, Application Definitions, and Contributed Definitions appear as subsections of a parent Contributed Definitions section. And, there is no additional content listed for sections Base classes and Application Definitions at that parent level (the page numbering reveals this, all on page 168). This is what looks odd. Highlighted with a red rectangle.

PeterC-DLS commented 2 years ago

I think this is caused by https://github.com/nexusformat/definitions/blob/157232732a9d5e7fd98b3e894bb746402bc6df4e/manual/source/classes/index.rst#L102-L107

I think the section number for the clase definitions is a little strange too (base classes is 3.3.3.1, etc) - perhaps there should be a "class definitions" section that has the actual links so base classes will be under 3.3.4.1. I opened issue #1168 for this.