-
Notifications
You must be signed in to change notification settings - Fork 94
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
cfg: document recurrence graph addition in config #4066
Conversation
date-time cycling: | ||
``T00,T06,T12,T18`` or ``PT6H`` - *every six hours* | ||
* ``R1`` - once at the intial cycle point | ||
* ``T00,T06,T12,T18`` - daily at 00:00, 06:00, 12:00 | ||
& 18:00 | ||
* ``PT6H`` - every six hours starting at the initial | ||
cycle point | ||
integer cycling: | ||
``P2`` - *every other cycle* | ||
* ``R1`` - once at the intial cycle point | ||
* ``P2`` - every other cycle | ||
* ``P3,P5`` - every third or fifth cycle |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you build this as is the formatting of integer cycling
and date-time cycling
is the same as that for config item.
date-time cycling: | |
``T00,T06,T12,T18`` or ``PT6H`` - *every six hours* | |
* ``R1`` - once at the intial cycle point | |
* ``T00,T06,T12,T18`` - daily at 00:00, 06:00, 12:00 | |
& 18:00 | |
* ``PT6H`` - every six hours starting at the initial | |
cycle point | |
integer cycling: | |
``P2`` - *every other cycle* | |
* ``R1`` - once at the intial cycle point | |
* ``P2`` - every other cycle | |
* ``P3,P5`` - every third or fifth cycle | |
date-time cycling: | |
* ``R1`` - once at the intial cycle point | |
* ``T00,T06,T12,T18`` - daily at 00:00, 06:00, 12:00 | |
& 18:00 | |
* ``PT6H`` - every six hours starting at the initial | |
cycle point | |
integer cycling: | |
* ``R1`` - once at the intial cycle point | |
* ``P2`` - every other cycle | |
* ``P3,P5`` - every third or fifth cycle |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I think that's a regression bug in the rtd theme, I seem to remember seeing an issue a while back, I thought it got fixed.
Your diff above converts the bullet point lists into block quotes. Would rather keep the RST correct and fix the rendering bug if possible.
definition list item:
definition list description
plain text:
blockquote
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here's the bug issue - readthedocs/sphinx_rtd_theme#800
It was fixed a while back but seems to be back, though in a slightly different form. Will try and find out if this is a design decision.
Just found this which may be somewhat related readthedocs/sphinx_rtd_theme#979 which is open.
Here's the intended appearance - https://sphinx-rtd-theme--981.org.readthedocs.build/en/981/demo/lists_tables.html#definition-lists
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep that's it.
However the definition style is still inconsistent with the others.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Raised an issue - readthedocs/sphinx_rtd_theme#1052
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The suggestion is tangential to the PR.
Having read your comments I'd be happy to merge. But if you'd rather I wait... |
Small change, realised that there is nothing in the config docs to explain the irregular behaviour of recurrence settings (now that they are settings not sections) so added a quick note.
Requirements check-list
CONTRIBUTING.md
and added my name as a Code Contributor.