add paragraph about version of spec and revision of document #26
Conversation
index.rst
Outdated
| .. BUILD: remember to also change in conf | ||
| This document is miniSEED 3 as revised 2023-01-17 (DRAFT). |
There was a problem hiding this comment.
I'm not very familiar with this environment so I have to ask whether it's feasible to avoid needing to specify the specification version in more than one place. For example, since conf.py is evaluated at runtime, can the version/revision info be written somewhere that can be picked up and rendered this file?
There was a problem hiding this comment.
Would be nice if it were automated and seems like something Sphinx would know how to do, @chad-earthscope do you know if/how this could be done?
There was a problem hiding this comment.
Would be nice if it were automated and seems like something Sphinx would know how to do, @chad-earthscope do you know if/how this could be done?
I've added code to this PR to use the centralized version information in conf.py. I'm good with merging but would ask someone else to review the changes before doing so.
PS for what it's worth I don't think many people know what Sphinx can do, and Sphinx + RST + HTML + Python == zero fun, everything feels like a kludge. /minirant
Co-authored-by: David Easton <djeastonca@users.noreply.github.com>
|
@djeastonca I updated your text to add a link to the header field for spec version, hopefully that helps |
Yes indeed - thanks for adding that link, since I overlooked doing that |
* add paragraph about version of spec and revision of document * Update index.rst Co-authored-by: David Easton <djeastonca@users.noreply.github.com> * fix error with comment, link to format version header * Add substitutions for central version definition * Use release as revision date for improved PDF rendering Co-authored-by: David Easton <djeastonca@users.noreply.github.com> Co-authored-by: chad-earthscope <chad.trabant@earthscope.org> Co-authored-by: Philip Crotwell <crotwell@seis.sc.edu> Co-authored-by: David Easton <djeastonca@users.noreply.github.com>
|
Thanks @chad-earthscope for the nice solution |
No description provided.