Add "scroll-top-bar: 2em;" for the "span" html element in custom.css so
that the top bar doesn't get in the way of headings bounded by the "span
element".
See also https://github.com/ceph/ceph/pull/49644.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
Add "scroll-margin-top: 4em;" to the h2 html element's definition in
custom.css. This moves the text under all h2 html elements out of the
way of the sticky-header-style top bar, which previously obscured the
text.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
Add 4em of padding to the class "section", so that linked-to
destinations are not obscured by the top bar.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
add "scroll-margin-top: em3;" to custom.css so that the header bar
doesn't obscure the text of headwords in glossary.rst. Note that this
applies only to elements in the documentation that are rendered into
HTML with the dt (which stands for "description term" or "description
list") tag. Other modifications will be necessary in order to ensure
that the anchor points of non-dt elements are not obscured by the header
bar.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
if $release is "dev", then the release being built is not a stable
version.
drop ceph.js, as the web page is generated at build time.
since the last user of "releases.json" is gone, now we can
drop the hooks preparing "releases.json" in conf.py as well.
Signed-off-by: Kefu Chai <kchai@redhat.com>
enable/disable #eol-warning based on "is_release_eol" context variable.
this allows us to generate a more static web page. and pave the road to
a releases.json-free doc build process.
Signed-off-by: Kefu Chai <kchai@redhat.com>
since we've migrated to RTD, a typical URL of ceph document looks like
https://docs.ceph.com/en/octopus/rados/
so instead of match "/docs.ceph.com/docs/<branch-name>/", we should
better match "/en/<branch-name>". in this change,
* do not include the domain name in the pattern to be matched,
it's not necessary.
* match with "/en/<branch-name>/"
Signed-off-by: Kefu Chai <kchai@redhat.com>
* `ul.simple > li` is also used in front page, where the items are too
sparse now. so we need to restore the default spacing.
* `ul.simple > li > ul > li:last-child` is used to control the spacing
between nested unordered list. we need have more spacing there.
* `div.section > ul > li > p` is added to decrease the spacing of nested
list items.
Signed-off-by: Kefu Chai <kchai@redhat.com>
by default, the user agent's css sets `margin-block-end` of "ul ul" to
"0", which renders the unordered lists in release notes cluttered. as we
are using nested unordered list to present the changes in different
components.
in this change a customized css is added to reset the begin and end
margin of ul to 1em, which is the default value of top level ul.
Signed-off-by: Kefu Chai <kchai@redhat.com>
we add this element in _templates/page.html, which is only used for the
content pages, not in the "search" page. to avoid the js errors, just
disabled it if it's not found.
Signed-off-by: Kefu Chai <kchai@redhat.com>