Commit Graph

12 Commits

Author SHA1 Message Date
Kefu Chai
7a62303b57 doc: check "release" context variable for #dev-warning
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>
2020-12-02 00:25:16 +08:00
Kefu Chai
448800d300 doc: disable eol-warning based on "is_release_eol"
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>
2020-12-02 00:25:16 +08:00
Kefu Chai
be26c566e5 doc: remove edit_on_github sphinx extension
Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-01 15:41:45 +08:00
Kefu Chai
0980cde334 doc/_static: match with branch encoded in pathname in URL
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>
2020-11-20 12:59:22 +08:00
Kefu Chai
23626401e9 doc: write releases.json to _static
this follows the convention of sphinx, so we can also customise this
path in future using "html_static_path". see also
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_static_path

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-20 12:59:22 +08:00
Kefu Chai
c555a4e10d doc/_static/css: fine tune the spacing
* `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>
2020-03-16 20:12:38 +08:00
Kefu Chai
e2e9de8b4d doc: overide the default margin for "ul.simple > li"
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>
2020-03-13 20:16:18 +08:00
Kefu Chai
3d129f45d4 doc/_static/js/ceph.js: avoid the "//" in URI
it's just annoying.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-02-28 10:08:49 +08:00
Kefu Chai
26a48b36f7 doc: do not use absolute address
use relative address instead, to ease the pain when testing.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-02-20 14:44:11 +08:00
Kefu Chai
9d2f6329b7 doc: do not try to patch #edit-on-github if not found
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>
2020-02-20 14:44:11 +08:00
Kefu Chai
eb247c943a doc: always load resources via HTTPS
Signed-off-by: Tiago Melo <tmelo@suse.com>
2019-08-22 16:19:17 +08:00
Noah Watkins
bb887b78f8 doc: show edit on github links and version warnings
Signed-off-by: Noah Watkins <noahwatkins@gmail.com>
2018-11-02 14:49:15 -07:00